/*
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * Copyright (c) 1999-2008 Apple Inc.  All Rights Reserved.
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 *
 */
 
/*
    File:       QTSSAccessLogModule.cpp

    Contains:   Implementation of an RTP access log module.
                    

*/

#include "QTSSAccessLogModule.h"
#include "QTSSModuleUtils.h"
#include "QTSSRollingLog.h"
#include "OSMutex.h"
#include "MyAssert.h"
#include "OSMemory.h"
#include <time.h>
#include "StringParser.h"
#include "StringFormatter.h"
#include "StringTranslator.h"
#include "StrPtrLen.h"
#include "UserAgentParser.h"
#include "Task.h"

#define TESTUNIXTIME 0

class QTSSAccessLog;
class LogCheckTask;

// STATIC DATA

// Default values for preferences
static Bool16   sDefaultLogEnabled          = true;
static char*    sDefaultLogName             = "StreamingServer";
static char*    sDefaultLogDir = NULL;
static QTSS_PrefsObject     sServerPrefs = NULL;
 
static UInt32   sDefaultMaxLogBytes         = 10240000;
static UInt32   sDefaultRollInterval        = 7;
static char*    sVoidField                  = "-";
static Bool16   sStartedUp                  = false;
static Bool16   sDefaultLogTimeInGMT        = true;

static QTSS_AttributeID sLoggedAuthorizationAttrID = qtssIllegalAttrID;

// Current values for preferences
static Bool16   sLogEnabled     = true;
static UInt32   sMaxLogBytes        = 51200000;
static UInt32   sRollInterval       = 7;
static Bool16   sLogTimeInGMT       = true;

static OSMutex*             sLogMutex   = NULL;//Log module isn't reentrant
static QTSSAccessLog*       sAccessLog  = NULL;
static QTSS_ServerObject    sServer     = NULL;
static QTSS_ModulePrefsObject sPrefs   	= NULL;
static LogCheckTask* sLogCheckTask = NULL;

// This header conforms to the W3C "Extended Log File Format". 
// (See "http://www.w3.org/TR/WD-logfile.html" for details.)
// The final remark filed of the log header tells us if the logged times are in GMT or in system local time.
static char* sLogHeader =   "#Software: %s\n"
                    "#Version: %s\n"    //%s == version
                    "#Date: %s\n"   //%s == date/time
                    "#Remark: all time values are in %s.\n" //%s == qtss_localtime or GMT
                    "#Fields: c-ip date time c-dns cs-uri-stem c-starttime x-duration c-rate c-status c-playerid"
                        " c-playerversion c-playerlanguage cs(User-Agent) c-os"
                        " c-osversion c-cpu filelength filesize avgbandwidth protocol transport audiocodec videocodec"
                        " sc-bytes cs-bytes c-bytes s-pkts-sent c-pkts-received c-pkts-lost-client c-buffercount"
                        " c-totalbuffertime c-quality s-ip s-dns s-totalclients s-cpu-util cs-uri-query c-username sc(Realm) \n";



//**************************************************
// CLASS DECLARATIONS
//**************************************************

class LogCheckTask : public Task
{
    public:
        LogCheckTask() : Task() {this->SetTaskName("LogCheckTask"); this->Signal(Task::kStartEvent); }
        virtual ~LogCheckTask() {}
        
    private:
        virtual SInt64 Run();
};

class QTSSAccessLog : public QTSSRollingLog
{
    public:
    
        QTSSAccessLog() : QTSSRollingLog() { this->SetTaskName("QTSSAccessLog");  }
        virtual ~QTSSAccessLog() {}
    
        virtual char* GetLogName() { return QTSSModuleUtils::GetStringAttribute(sPrefs, "request_logfile_name", sDefaultLogName); }
        virtual char* GetLogDir()  { return QTSSModuleUtils::GetStringAttribute(sPrefs, "request_logfile_dir", sDefaultLogDir); }
        virtual UInt32 GetRollIntervalInDays()  { return sRollInterval; }
        virtual UInt32 GetMaxLogBytes()         { return sMaxLogBytes; }
        virtual time_t WriteLogHeader(FILE *inFile);
    
};

// FUNCTION PROTOTYPES

static QTSS_Error   QTSSAccessLogModuleDispatch(QTSS_Role inRole, QTSS_RoleParamPtr inParamBlock);
static QTSS_Error   Register(QTSS_Register_Params* inParams);
static QTSS_Error   Initialize(QTSS_Initialize_Params* inParams);
static QTSS_Error   RereadPrefs();
static QTSS_Error   Shutdown();
static QTSS_Error   PostProcess(QTSS_StandardRTSP_Params* inParams);
static QTSS_Error   ClientSessionClosing(QTSS_ClientSessionClosing_Params* inParams);
static QTSS_Error   LogRequest( QTSS_ClientSessionObject inClientSession,
                            QTSS_RTSPSessionObject inRTSPSession,QTSS_CliSesClosingReason *inCloseReasonPtr);
static void             CheckAccessLogState(Bool16 forceEnabled);
static QTSS_Error   RollAccessLog(QTSS_ServiceFunctionArgsPtr inArgs);
static void         ReplaceSpaces(StrPtrLen *sourcePtr, StrPtrLen *destPtr, char *replaceStr);

static QTSS_Error   StateChange(QTSS_StateChange_Params* stateChangeParams);
static void         WriteStartupMessage();
static void         WriteShutdownMessage();

// FUNCTION IMPLEMENTATIONS

QTSS_Error QTSSAccessLogModule_Main(void* inPrivateArgs)
{
    return _stublibrary_main(inPrivateArgs, QTSSAccessLogModuleDispatch);
}

QTSS_Error QTSSAccessLogModuleDispatch(QTSS_Role inRole, QTSS_RoleParamPtr inParamBlock)
{
    switch (inRole)
    {
        case QTSS_Register_Role:
            return Register(&inParamBlock->regParams);
        case QTSS_StateChange_Role:
            return StateChange(&inParamBlock->stateChangeParams);
        case QTSS_Initialize_Role:
            return Initialize(&inParamBlock->initParams);
        case QTSS_RereadPrefs_Role:
            return RereadPrefs();
        case QTSS_RTSPPostProcessor_Role:
            return PostProcess(&inParamBlock->rtspPostProcessorParams);
        case QTSS_ClientSessionClosing_Role:
            return ClientSessionClosing(&inParamBlock->clientSessionClosingParams);
        case QTSS_Shutdown_Role:
            return Shutdown();
    }
    return QTSS_NoErr;
}


QTSS_Error Register(QTSS_Register_Params* inParams)
{
    sLogMutex = NEW OSMutex();
    
    // Do role & service setup
    
    (void)QTSS_AddRole(QTSS_Initialize_Role);
    (void)QTSS_AddRole(QTSS_RTSPPostProcessor_Role);
    (void)QTSS_AddRole(QTSS_ClientSessionClosing_Role);
    (void)QTSS_AddRole(QTSS_RereadPrefs_Role);
    (void)QTSS_AddRole(QTSS_Shutdown_Role);
    (void)QTSS_AddRole(QTSS_StateChange_Role);

    (void)QTSS_AddService("RollAccessLog", &RollAccessLog);
    
    // Tell the server our name!
    static char* sModuleName = "QTSSAccessLogModule";
    ::strcpy(inParams->outModuleName, sModuleName);

    static char*        sLoggedAuthorizationName = "QTSSAccessLogModuleLoggedAuthorization";
    
    (void)QTSS_AddStaticAttribute(qtssClientSessionObjectType, sLoggedAuthorizationName, NULL, qtssAttrDataTypeUInt32);
    (void)QTSS_IDForAttr(qtssClientSessionObjectType, sLoggedAuthorizationName, &sLoggedAuthorizationAttrID);

    return QTSS_NoErr;
}


QTSS_Error Initialize(QTSS_Initialize_Params* inParams)
{
    QTSSModuleUtils::Initialize(inParams->inMessages, inParams->inServer, inParams->inErrorLogStream);
    sServer = inParams->inServer;
    sPrefs = QTSSModuleUtils::GetModulePrefsObject(inParams->inModule);
    sServerPrefs = inParams->inPrefs;
   
    RereadPrefs();
    WriteStartupMessage();
    sLogCheckTask = NEW LogCheckTask();
    return QTSS_NoErr;
}


QTSS_Error RereadPrefs()
{
    delete [] sDefaultLogDir;
    (void)QTSS_GetValueAsString(sServerPrefs, qtssPrefsErrorLogDir, 0, &sDefaultLogDir);

    QTSSModuleUtils::GetAttribute(sPrefs, "request_logging",    qtssAttrDataTypeBool16,
                                &sLogEnabled, &sDefaultLogEnabled, sizeof(sLogEnabled));
    QTSSModuleUtils::GetAttribute(sPrefs, "request_logfile_size",   qtssAttrDataTypeUInt32,
                                &sMaxLogBytes, &sDefaultMaxLogBytes, sizeof(sMaxLogBytes));
    QTSSModuleUtils::GetAttribute(sPrefs, "request_logfile_interval",   qtssAttrDataTypeUInt32,
                                &sRollInterval, &sDefaultRollInterval, sizeof(sRollInterval));
    QTSSModuleUtils::GetAttribute(sPrefs, "request_logtime_in_gmt",     qtssAttrDataTypeBool16,
                                &sLogTimeInGMT, &sDefaultLogTimeInGMT, sizeof(sLogTimeInGMT));

    CheckAccessLogState(false);

    return QTSS_NoErr;
}


QTSS_Error Shutdown()
{
    WriteShutdownMessage();
    if (sLogCheckTask != NULL)
    {
        //sLogCheckTask is a task object, so don't delete it directly
        // instead we signal it to kill itself.
        sLogCheckTask->Signal(Task::kKillEvent); 
        sLogCheckTask = NULL;
    }
    return QTSS_NoErr;
}

QTSS_Error StateChange(QTSS_StateChange_Params* stateChangeParams)
{
    if (stateChangeParams->inNewState == qtssIdleState)
        WriteShutdownMessage();
    else if (stateChangeParams->inNewState == qtssRunningState)
        WriteStartupMessage();
    
    return QTSS_NoErr;
}



QTSS_Error PostProcess(QTSS_StandardRTSP_Params* inParams)
{
    static UInt32 sZero = 0;
    
    UInt32* theStatus = NULL;
    UInt32 theLen = 0;
    QTSS_Error theErr = QTSS_GetValuePtr(inParams->inRTSPRequest, qtssRTSPReqRealStatusCode, 0, (void**)&theStatus, &theLen);
    if (theErr != QTSS_NoErr)
        return theErr;
    
    QTSS_CliSesClosingReason theReason = qtssCliSesCloseClientTeardown;
    
    if ((*theStatus == 401) || (*theStatus == 403))
    {
        LogRequest(inParams->inClientSession, NULL, &theReason);
        (void)QTSS_SetValue(inParams->inClientSession, sLoggedAuthorizationAttrID, 0, theStatus, sizeof(*theStatus));
    }
    else
        (void)QTSS_SetValue(inParams->inClientSession, sLoggedAuthorizationAttrID, 0, &sZero, sizeof(sZero));
        
    return theErr;
}

#if TESTUNIXTIME
void TestUnixTime(time_t theTime, char *ioDateBuffer);
void TestUnixTime(time_t theTime, char *ioDateBuffer)
{
    Assert(NULL != ioDateBuffer);
    
    //use ansi routines for getting the date.
    time_t calendarTime = theTime;
    Assert(-1 != calendarTime);
    if (-1 == calendarTime)
        return;
        
    struct tm  timeResult;
    struct tm* theLocalTime = qtss_localtime(&calendarTime, &timeResult);
    Assert(NULL != theLocalTime);
    if (NULL == theLocalTime)
        return;
        
    //date needs to look like this for common log format: 29/Sep/1998:11:34:54 -0700
    //this wonderful ANSI routine just does it for you.
    //qtss_strftime(ioDateBuffer, kMaxDateBufferSize, "%d/%b/%Y:%H:%M:%S", theLocalTime);
    qtss_strftime(ioDateBuffer,QTSSRollingLog::kMaxDateBufferSizeInBytes, "%Y-%m-%d %H:%M:%S", theLocalTime);  
    return;
}
#endif


QTSS_Error ClientSessionClosing(QTSS_ClientSessionClosing_Params* inParams)
{
    return LogRequest(inParams->inClientSession, NULL, &inParams->inReason);
}

void ReplaceSpaces(StrPtrLen *sourcePtr, StrPtrLen *destPtr, char *replaceStr)
{

    if ( (NULL != destPtr) && (NULL != destPtr->Ptr) && (0 < destPtr->Len) ) destPtr->Ptr[0] = 0;
    do
    {
        if  (  (NULL == sourcePtr) 
            || (NULL == destPtr)
            || (NULL == sourcePtr->Ptr)
            || (NULL == destPtr->Ptr) 
            || (0 == sourcePtr->Len) 
            || (0 == destPtr->Len) 
            )    break;
        
        if (0 == sourcePtr->Ptr[0]) 
        {    
            destPtr->Len = 0;
            break;
        }
    
        const StrPtrLen replaceValue(replaceStr);
        StringFormatter formattedString(destPtr->Ptr, destPtr->Len);
        StringParser sourceStringParser(sourcePtr);
        StrPtrLen preStopChars;
        
        do
        {   sourceStringParser.ConsumeUntil(&preStopChars, StringParser::sEOLWhitespaceMask);
            if (preStopChars.Len > 0)
            {   formattedString.Put(preStopChars);// copy the string up to the space or eol. it will be truncated if there's not enough room.
                if ( sourceStringParser.Expect(' ') && (formattedString.GetSpaceLeft() > replaceValue.Len) )
                {   formattedString.Put(replaceValue.Ptr, replaceValue.Len);
                }
                else //no space character or no room for replacement
                {    break; 
                }
            }

        } while ( preStopChars.Len != 0);
        
        destPtr->Set(formattedString.GetBufPtr(), formattedString.GetBytesWritten() );
        
    } while (false);
}   


QTSS_Error LogRequest( QTSS_ClientSessionObject inClientSession,
                            QTSS_RTSPSessionObject inRTSPSession, QTSS_CliSesClosingReason *inCloseReasonPtr)
{
    static StrPtrLen sUnknownStr(sVoidField);
    static StrPtrLen sTCPStr("TCP");
    static StrPtrLen sUDPStr("UDP");
    
    //Fetch the URL, user agent, movielength & movie bytes to log out of the RTP session
    enum {  
            eTempLogItemSize    = 256, // must be same or larger than others
            eURLSize            = 256, 
            eUserAgentSize      = 256, 
            ePlayerIDSize       = 32, 
            ePlayerVersionSize  = 32, 
            ePlayerLangSize     = 32, 
            ePlayerOSSize       = 32, 
            ePlayerOSVersSize   = 32,
            ePlayerCPUSize      = 32 
        };
    
    char tempLogItemBuf[eTempLogItemSize] = { 0 };  
    StrPtrLen tempLogStr(tempLogItemBuf, eTempLogItemSize -1);
    
    //
    // Check to see if this session is closing because authorization failed. If that's
    // the case, we've logged that already, let's not log it twice
    
    UInt32 theLen = 0;
    UInt32* authorizationFailed = NULL;
    (void)QTSS_GetValuePtr(inClientSession, sLoggedAuthorizationAttrID, 0, (void**)&authorizationFailed, &theLen);
    if ((authorizationFailed != NULL) && (*authorizationFailed > 0))
        return QTSS_NoErr;

    ///inClientSession should never be NULL
    //inRTSPRequest may be NULL if this is a timeout
    
    OSMutexLocker locker(sLogMutex);
    CheckAccessLogState(false);
    if (sAccessLog == NULL)
        return QTSS_NoErr;
        
    //if logging is on, then log the request... first construct a timestamp
    char theDateBuffer[QTSSRollingLog::kMaxDateBufferSizeInBytes];
    Bool16 result = QTSSRollingLog::FormatDate(theDateBuffer, sLogTimeInGMT);
    

    //for now, just ignore the error.
    if (!result)
        theDateBuffer[0] = '\0';
    
    theLen = sizeof(QTSS_RTSPSessionObject);
    QTSS_RTSPSessionObject theRTSPSession = inRTSPSession;
    if (theRTSPSession == NULL)
        (void)QTSS_GetValue(inClientSession, qtssCliSesLastRTSPSession, 0, (void*) &theRTSPSession, &theLen);
    
    // Get lots of neat info to log from the various dictionaries

    // Each attribute must be copied out to ensure that it is NULL terminated.
    // To ensure NULL termination, just memset the buffers to 0, and make sure that
    // the last byte of each array is untouched.
    
    Float32* packetLossPercent = NULL;
    Float64* movieDuration = NULL;
    UInt64* movieSizeInBytes = NULL;
    UInt32* movieAverageBitRatePtr = 0;
    UInt32 clientPacketsReceived = 0;
    UInt32 clientPacketsLost = 0;
    StrPtrLen* theTransportType = &sUnknownStr;
    SInt64* theCreateTime = NULL;
    SInt64* thePlayTime = NULL;
    
    UInt32 startPlayTimeInSecs = 0;
        
    char localIPAddrBuf[20] = { 0 };
    StrPtrLen localIPAddr(localIPAddrBuf, 19);

    char localDNSBuf[70] = { 0 };
    StrPtrLen localDNS(localDNSBuf, 69);

    char remoteDNSBuf[70] = { 0 };
    StrPtrLen remoteDNS(remoteDNSBuf, 69);

    char remoteAddrBuf[20] = { 0 }; 
    StrPtrLen remoteAddr(remoteAddrBuf, 19);
    
    char playerIDBuf[ePlayerIDSize] = { 0 };    
    StrPtrLen playerID(playerIDBuf, ePlayerIDSize -1) ;
    
    // First, get networking info from the RTSP session
    (void)QTSS_GetValue(inClientSession, qtssCliRTSPSessLocalAddrStr, 0, localIPAddr.Ptr, &localIPAddr.Len);
    (void)QTSS_GetValue(inClientSession, qtssCliRTSPSessLocalDNS, 0, localDNS.Ptr, &localDNS.Len);
    (void)QTSS_GetValue(inClientSession, qtssCliSesHostName, 0, remoteDNS.Ptr, &remoteDNS.Len);
    (void)QTSS_GetValue(inClientSession, qtssCliRTSPSessRemoteAddrStr, 0, remoteAddr.Ptr, &remoteAddr.Len);
    (void)QTSS_GetValue(inClientSession, qtssCliRTSPSessRemoteAddrStr, 0, playerID.Ptr, &playerID.Len);
            
    UInt32* rtpBytesSent = NULL;
    UInt32* rtcpBytesRecv = NULL;
    UInt32* rtpPacketsSent = NULL;
    UInt32 clientBytesRecv = 0;
    
    // Second, get networking info from the Client's session.
    // (Including the stats for incoming RTCP packets.)
    char urlBuf[eURLSize] = { 0 };  
    StrPtrLen url(urlBuf, eURLSize -1);
    (void)QTSS_GetValue(inClientSession, qtssCliSesPresentationURL, 0, url.Ptr, &url.Len);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesPacketLossPercent, 0, (void**)&packetLossPercent, &theLen);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesMovieDurationInSecs, 0, (void**)&movieDuration, &theLen);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesMovieSizeInBytes, 0, (void**)&movieSizeInBytes, &theLen);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesMovieAverageBitRate, 0, (void**)&movieAverageBitRatePtr, &theLen);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesCreateTimeInMsec, 0, (void**)&theCreateTime, &theLen);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesFirstPlayTimeInMsec, 0, (void**)&thePlayTime, &theLen);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesRTPBytesSent, 0, (void**)&rtpBytesSent, &theLen);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesRTPPacketsSent, 0, (void**)&rtpPacketsSent, &theLen);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliSesRTCPBytesRecv, 0, (void**)&rtcpBytesRecv, &theLen);
    
    if (theCreateTime != NULL && thePlayTime != NULL)
        startPlayTimeInSecs = (UInt32)(((*theCreateTime - *thePlayTime)/1000)+0.5);

   
    // We need a value of 'c-bytes' to report as a log entry. This is supposed to be the total number
    // of bytes the client has received during the session. Unfortunately, the QT client does not give
    // us this number. We will use the following heuristic formula to estimate the number of bytes the
    // client has received during the session:
    //
    //     client-bytes-received = bytes-sent * (100.0 - percent-packet-lost) / 100.0
    //
    // The 'percent-packet-lost' value has been calculated internally by QTSS based on the RTCP packets
    // sent to the server from the client. If those values are accurate then the above formula will not 
    // be exactly correct but it will be nearly correct.
    
    clientBytesRecv = (UInt32)((*rtpBytesSent * (100.0 - *packetLossPercent))/100.0);
    
    tempLogStr.Ptr[0] = 0; tempLogStr.Len = eUserAgentSize;
    (void)QTSS_GetValue(inClientSession, qtssCliSesFirstUserAgent, 0, tempLogStr.Ptr, &tempLogStr.Len);
    
    char userAgentBuf[eUserAgentSize] = { 0 };  
    StrPtrLen userAgent(userAgentBuf, eUserAgentSize -1);
    ReplaceSpaces(&tempLogStr, &userAgent, "%20");
    
    UserAgentParser userAgentParser(&userAgent);
    
//  StrPtrLen* playerID = userAgentParser.GetUserID() ;
    StrPtrLen* playerVersion = userAgentParser.GetUserVersion() ;
    StrPtrLen* playerLang = userAgentParser.GetUserLanguage()  ;
    StrPtrLen* playerOS = userAgentParser.GetrUserOS()  ;
    StrPtrLen* playerOSVers = userAgentParser.GetUserOSVersion()  ;
    StrPtrLen* playerCPU = userAgentParser.GetUserCPU()  ;
    
//  char playerIDBuf[ePlayerIDSize] = {};   
    char playerVersionBuf[ePlayerVersionSize] = { 0 };  
    char playerLangBuf[ePlayerLangSize] = { 0 };        
    char playerOSBuf[ePlayerOSSize] = { 0 };    
    char playerOSVersBuf[ePlayerOSVersSize] = { 0 };    
    char playerCPUBuf[ePlayerCPUSize] = { 0 };  
    
    UInt32 size;
//  (ePlayerIDSize < playerID->Len ) ? size = ePlayerIDSize -1 : size = playerID->Len;
//  if (playerID->Ptr != NULL) memcpy (playerIDBuf, playerID->Ptr, size);

    (ePlayerVersionSize < playerVersion->Len ) ? size = ePlayerVersionSize -1 : size = playerVersion->Len;
    if (playerVersion->Ptr != NULL) memcpy (playerVersionBuf, playerVersion->Ptr, size);

    (ePlayerLangSize < playerLang->Len ) ? size = ePlayerLangSize -1 : size = playerLang->Len;
    if (playerLang->Ptr != NULL) memcpy (playerLangBuf, playerLang->Ptr, size);

    (ePlayerOSSize < playerOS->Len ) ? size = ePlayerOSSize -1 : size = playerOS->Len;
    if (playerOS->Ptr != NULL)  memcpy (playerOSBuf, playerOS->Ptr, size);

    (ePlayerOSVersSize < playerOSVers->Len ) ? size = ePlayerOSVersSize -1 : size = playerOSVers->Len;
    if (playerOSVers->Ptr != NULL) memcpy (playerOSVersBuf, playerOSVers->Ptr, size);
    
    (ePlayerCPUSize < playerCPU->Len ) ? size = ePlayerCPUSize -1 : size = playerCPU->Len;
    if (playerCPU->Ptr != NULL) memcpy (playerCPUBuf, playerCPU->Ptr, size);

    
    // clientPacketsReceived, clientPacketsLost, videoPayloadName and audioPayloadName
    // are all stored on a per-stream basis, so let's iterate through all the streams,
    // finding this information

    char videoPayloadNameBuf[32]  = { 0 };  
    StrPtrLen videoPayloadName(videoPayloadNameBuf, 31);

    char audioPayloadNameBuf[32] = { 0 };   
    StrPtrLen audioPayloadName(audioPayloadNameBuf, 31);

    UInt32 qualityLevel = 0;
    UInt32 clientBufferTime = 0;
    UInt32 theStreamIndex = 0;
    Bool16* isTCPPtr = NULL;
    QTSS_RTPStreamObject theRTPStreamObject = NULL;
    
    for (   UInt32 theStreamObjectLen = sizeof(theRTPStreamObject);
            QTSS_GetValue(inClientSession, qtssCliSesStreamObjects, theStreamIndex, (void*)&theRTPStreamObject, &theStreamObjectLen) == QTSS_NoErr;
            theStreamIndex++, theStreamObjectLen = sizeof(theRTPStreamObject))
    {
        
        UInt32* streamPacketsReceived = NULL;
        UInt32* streamPacketsLost = NULL;
        (void)QTSS_GetValuePtr(theRTPStreamObject, qtssRTPStrTotPacketsRecv, 0, (void**)&streamPacketsReceived, &theLen);
        (void)QTSS_GetValuePtr(theRTPStreamObject, qtssRTPStrTotalLostPackets, 0, (void**)&streamPacketsLost, &theLen);
        
        // Add up packets received and packets lost to come up with a session wide total
        if (streamPacketsReceived != NULL)
            clientPacketsReceived += *streamPacketsReceived;
        if (streamPacketsLost != NULL)
            clientPacketsLost += *streamPacketsLost;
        
        // Identify the video and audio codec types
        QTSS_RTPPayloadType* thePayloadType = NULL;
        (void)QTSS_GetValuePtr(theRTPStreamObject, qtssRTPStrPayloadType, 0, (void**)&thePayloadType, &theLen);
        if (thePayloadType != NULL)
        {
            if (*thePayloadType == qtssVideoPayloadType)
                (void)QTSS_GetValue(theRTPStreamObject, qtssRTPStrPayloadName, 0, videoPayloadName.Ptr, &videoPayloadName.Len);
            else if (*thePayloadType == qtssAudioPayloadType)   
                (void)QTSS_GetValue(theRTPStreamObject, qtssRTPStrPayloadName, 0, audioPayloadName.Ptr, &audioPayloadName.Len);
        }
        
        // If any one of the streams is being delivered over UDP instead of TCP,
        // report in the log that the transport type for this session was UDP.
        if (isTCPPtr == NULL)
        {   
            (void)QTSS_GetValuePtr(theRTPStreamObject, qtssRTPStrIsTCP, 0, (void**)&isTCPPtr, &theLen);
            if (isTCPPtr != NULL)
            {   if (*isTCPPtr == false)
                    theTransportType = &sUDPStr;
                else
                    theTransportType = &sTCPStr;
            }
        }
        
        Float32* clientBufferTimePtr = NULL;
        (void)QTSS_GetValuePtr(theRTPStreamObject, qtssRTPStrBufferDelayInSecs, 0, (void**)&clientBufferTimePtr, &theLen);
        if  ( (clientBufferTimePtr != NULL) && (*clientBufferTimePtr != 0) )
        {   if ( *clientBufferTimePtr  > clientBufferTime)
                clientBufferTime = (UInt32) (*clientBufferTimePtr + .5); // round up to full seconds
        }
        
    }
    
    // Add the client buffer time to our client start latency (in whole seconds).
    startPlayTimeInSecs += clientBufferTime;

    if (*rtpPacketsSent == 0) // no packets sent
        qualityLevel = 0; // no quality
    else
    {
        if ( (clientPacketsReceived == 0) && (clientPacketsLost == 0) ) // no info from client 
            qualityLevel = 100; //so assume 100
        else
        {   
            float qualityPercent =  (float) clientPacketsReceived / (float) (clientPacketsReceived + clientPacketsLost);
            qualityPercent += (float).005; // round up
            qualityLevel = (UInt32) ( (float) 100.0 * qualityPercent); // average of sum of packet counts for all streams
        }
    }
    
    //we may not have an RTSP request. Assume that the status code is 504 timeout, if there is an RTSP
    //request, though, we can find out what the real status code of the response is
    static UInt32 sTimeoutCode = 504;   
    UInt32* theStatusCode = &sTimeoutCode;
    theLen = sizeof(UInt32);
    (void)QTSS_GetValuePtr(inClientSession, qtssCliRTSPReqRealStatusCode, 0, (void **) &theStatusCode, &theLen);
//  qtss_printf("qtssCliRTSPReqRealStatusCode = %"_U32BITARG_" \n", *theStatusCode);
        
    
    if (inCloseReasonPtr) do
    {
        if (*theStatusCode < 300) // it was a succesful RTSP request but...
        {   
            if (*inCloseReasonPtr == qtssCliSesCloseTimeout) // there was a timeout
            {   
                    *theStatusCode = sTimeoutCode;
//                  qtss_printf(" log timeout ");
                    break;
            }

            if (*inCloseReasonPtr == qtssCliSesCloseClientTeardown) // there was a teardown
            {
            
                static QTSS_CliSesClosingReason sReason = qtssCliSesCloseClientTeardown;
                QTSS_CliSesClosingReason* theReasonPtr = &sReason;
                theLen = sizeof(QTSS_CliSesTeardownReason);
                (void)QTSS_GetValuePtr(inClientSession, qtssCliTeardownReason, 0, (void **) &theReasonPtr, &theLen);
//              qtss_printf("qtssCliTeardownReason = %"_U32BITARG_" \n", *theReasonPtr);

                if (*theReasonPtr == qtssCliSesTearDownClientRequest) //  the client asked for a tear down
                {
//                  qtss_printf(" client requests teardown  ");
                    break;
                }
                
                if (*theReasonPtr == qtssCliSesTearDownUnsupportedMedia) //  An error occured while streaming the file.
                {   
                        *theStatusCode = 415;
//                      qtss_printf(" log UnsupportedMedia ");
                        break;
                }
                if (*theReasonPtr == qtssCliSesTearDownBroadcastEnded) //  a broadcaster stopped broadcasting
                {   
                        *theStatusCode = 452;
//                      qtss_printf(" log broadcast removed ");
                        break;
                }
    
                *theStatusCode = 500; // some unknown reason for cancelling the connection
            }
            
//          qtss_printf("return status ");
            // just use the qtssCliRTSPReqRealStatusCode for the reason
        }
                
    } while (false);

//  qtss_printf(" = %"_U32BITARG_" \n", *theStatusCode);

        
    // Find out what time it is
    SInt64 curTime = QTSS_Milliseconds();
    
    UInt32 numCurClients = 0;
    theLen = sizeof(numCurClients);
    (void)QTSS_GetValue(sServer, qtssRTPSvrCurConn, 0, &numCurClients, &theLen);

/*
    IMPORTANT!!!!
    
    Some values such as cpu, #conns, need to be grabbed as the session starts, not when the teardown happened (I think)

*/  

#if TESTUNIXTIME
    char thetestDateBuffer[QTSSRollingLog::kMaxDateBufferSizeInBytes];
    TestUnixTime(QTSS_MilliSecsTo1970Secs(*theCreateTime), thetestDateBuffer);
    qtss_printf("%s\n",thetestDateBuffer);
#endif
    
    float zeroFloat = 0;
    UInt64 zeroUInt64 = 0;
    Float32 fcpuUtilized = 0;
    UInt32 cpuUtilized = 0; // percent
        
	theLen = sizeof(fcpuUtilized);
	(void)QTSS_GetValue(sServer, qtssSvrCPULoadPercent, 0, &fcpuUtilized, &theLen);
	cpuUtilized = (UInt32)fcpuUtilized;

    char lastUserName[eTempLogItemSize] ={ 0 };
    StrPtrLen lastUserNameStr(lastUserName,eTempLogItemSize);
    
    char lastURLRealm[eTempLogItemSize] ={ 0 };
    StrPtrLen lastURLRealmStr(lastURLRealm,eTempLogItemSize);
    
    //qtss_printf("logging of saved params are in dictionary \n");
        
    tempLogStr.Ptr[0] = 0; tempLogStr.Len = eTempLogItemSize;
    (void)QTSS_GetValue(inClientSession, qtssCliRTSPSesUserName, 0, tempLogStr.Ptr, &tempLogStr.Len);
    ReplaceSpaces(&tempLogStr, &lastUserNameStr, "%20");
    //qtss_printf("qtssRTSPSesLastUserName dictionary item = %s len = %"_S32BITARG_"\n",lastUserNameStr.Ptr,lastUserNameStr.Len);
        
    tempLogStr.Ptr[0] = 0; tempLogStr.Len = eTempLogItemSize;
    (void)QTSS_GetValue(inClientSession, qtssCliRTSPSesURLRealm, 0, tempLogStr.Ptr, &tempLogStr.Len);
    ReplaceSpaces(&tempLogStr, &lastURLRealmStr, "%20");
    //qtss_printf("qtssRTSPSesLastURLRealm dictionary  item = %s len = %"_S32BITARG_"\n",lastURLRealmStr.Ptr,lastURLRealmStr.Len);  

    char respMsgBuffer[1024] = { 0 };
    StrPtrLen theRespMsg;   
    (void)QTSS_GetValuePtr(inClientSession, qtssCliRTSPReqRespMsg, 0, (void**)&theRespMsg.Ptr, &theRespMsg.Len);
    StrPtrLen respMsgEncoded(respMsgBuffer, 1024 -1);
    SInt32 theErr = StringTranslator::EncodeURL(theRespMsg.Ptr, theRespMsg.Len, respMsgEncoded.Ptr, respMsgEncoded.Len);
    if (theErr <= 0)
        respMsgEncoded.Ptr[0] = '\0';
    else
    {
        respMsgEncoded.Len = theErr;
        respMsgEncoded.Ptr[respMsgEncoded.Len] = '\0';
    }
    
    //cs-uri-query
    char urlQryBuf[eURLSize] = { 0 };
    StrPtrLen urlQry(urlQryBuf, eURLSize -1);
    (void)QTSS_GetValue(inClientSession, qtssCliSesReqQueryString, 0, urlQry.Ptr, &urlQry.Len);
    
    char tempLogBuffer[1024];
    char logBuffer[2048];
    // compatible fields (no respMsgEncoded field)
    ::memset(logBuffer, 0, 2048);
    qtss_sprintf(tempLogBuffer, "%s ", (remoteAddr.Ptr[0] == '\0') ? sVoidField : remoteAddr.Ptr); //c-ip*
    ::strcpy(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (theDateBuffer[0] == '\0') ? sVoidField : theDateBuffer);   //date* time*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (remoteDNS.Ptr[0] == '\0') ? sVoidField : remoteDNS.Ptr); //c-dns
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (url.Ptr[0] == '\0') ? sVoidField : url.Ptr);   //cs-uri-stem*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", startPlayTimeInSecs);  //c-starttime 
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", theCreateTime == NULL ? (UInt32) 0 : (UInt32) (QTSS_MilliSecsTo1970Secs(curTime)  
                        - QTSS_MilliSecsTo1970Secs(*theCreateTime)));   //x-duration* 
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_S32BITARG_" ", (UInt32) 1);  //c-rate
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_S32BITARG_" ", *theStatusCode);   //c-status*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (playerIDBuf[0] == '\0') ? sVoidField : playerIDBuf);   //c-playerid*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (playerVersionBuf[0] == '\0') ? sVoidField : playerVersionBuf); //c-playerversion
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (playerLangBuf[0] == '\0') ? sVoidField : playerLangBuf);   //c-playerlanguage*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (userAgent.Ptr[0] == '\0') ? sVoidField : userAgent.Ptr);   //cs(User-Agent) 
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (playerOSBuf[0] == '\0') ? sVoidField : playerOSBuf);   //c-os*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (playerOSVersBuf[0] == '\0') ? sVoidField : playerOSVersBuf);   //c-osversion
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (playerCPUBuf[0] == '\0') ? sVoidField : playerCPUBuf); //c-cpu*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%0.0f ", movieDuration == NULL ? zeroFloat : *movieDuration); //filelength in secs*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_64BITARG_"d ", movieSizeInBytes == NULL ? zeroUInt64 : *movieSizeInBytes); //filesize in bytes*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", movieAverageBitRatePtr == NULL ? (UInt32) 0 : *movieAverageBitRatePtr);    //avgbandwidth in bits per second
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", "RTP"); //protocol
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (theTransportType->Ptr[0] == '\0') ? sVoidField : theTransportType->Ptr);   //transport
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (audioPayloadName.Ptr[0] == '\0') ? sVoidField : audioPayloadName.Ptr); //audiocodec*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (videoPayloadName.Ptr[0] == '\0') ? sVoidField : videoPayloadName.Ptr); //videocodec*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ",rtpBytesSent == NULL ? (UInt32) 0 : *rtpBytesSent);    //sc-bytes*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ",rtcpBytesRecv == NULL ? (UInt32) 0 : *rtcpBytesRecv);    //cs-bytes*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", clientBytesRecv);  //c-bytes
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", rtpPacketsSent == NULL ? (UInt32)0 : *rtpPacketsSent);   //s-pkts-sent*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", clientPacketsReceived);    //c-pkts-recieved
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", clientPacketsLost);    //c-pkts-lost-client*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", (UInt32)1);  //c-buffercount 
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", clientBufferTime);     //c-totalbuffertime*
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", qualityLevel); //c-quality 
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (localIPAddr.Ptr[0] == '\0') ? sVoidField : localIPAddr.Ptr);   //s-ip 
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (localDNS.Ptr[0] == '\0') ? sVoidField : localDNS.Ptr); //s-dns
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", numCurClients);    //s-totalclients
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%"_U32BITARG_" ", cpuUtilized);  //s-cpu-util
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (urlQry.Ptr[0] == '\0') ? sVoidField : urlQry.Ptr); //cs-uri-query
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (lastUserName[0] == '\0') ? sVoidField : lastUserName); //c-username
    ::strcat(logBuffer, tempLogBuffer);
    qtss_sprintf(tempLogBuffer, "%s ", (lastURLRealm[0] == '\0') ? sVoidField : lastURLRealm); //sc(Realm)
    ::strcat(logBuffer, tempLogBuffer);
    
    ::strcat(logBuffer, "\n");

    Assert(::strlen(logBuffer) < 2048);
    
    //finally, write the log message
    sAccessLog->WriteToLog(logBuffer, kAllowLogToRoll);
    
    return QTSS_NoErr;
}


void CheckAccessLogState(Bool16 forceEnabled)
{
    //this function makes sure the logging state is in synch with the preferences.
    //extern variable declared in QTSSPreferences.h
    //check error log.
    if ((NULL == sAccessLog) && (forceEnabled || sLogEnabled))
    {
        sAccessLog = NEW QTSSAccessLog();
        sAccessLog->EnableLog();
    }

    if ((NULL != sAccessLog) && ((!forceEnabled) && (!sLogEnabled)))
    {
        sAccessLog->Delete(); //sAccessLog is a task object, so don't delete it directly
        sAccessLog = NULL;
    }
}

// SERVICE ROUTINES

QTSS_Error RollAccessLog(QTSS_ServiceFunctionArgsPtr /*inArgs*/)
{
    const Bool16 kForceEnable = true;

    OSMutexLocker locker(sLogMutex);
    //calling CheckLogState is a kludge to allow logs
    //to be rolled while logging is disabled.

    CheckAccessLogState(kForceEnable);
    
    if (sAccessLog != NULL )
        sAccessLog->RollLog();
        
    CheckAccessLogState(!kForceEnable);
    return QTSS_NoErr;
}

// This task runs once an hour to check and see if the log needs to roll.
SInt64 LogCheckTask::Run()
{
    static Bool16 firstTime = true;
    
    // don't check the log for rolling the first time we run.
    if (firstTime)
    {
        firstTime = false;
    }
    else
    {
        Bool16 success = false;

        if (sAccessLog != NULL && sAccessLog->IsLogEnabled())
            success = sAccessLog->CheckRollLog();
        Assert(success);
    }
    // execute this task again in one hour.
    return (60*60*1000);
}

time_t QTSSAccessLog::WriteLogHeader(FILE *inFile)
{
    time_t calendarTime = QTSSRollingLog::WriteLogHeader(inFile);

    //format a date for the startup time
    char theDateBuffer[QTSSRollingLog::kMaxDateBufferSizeInBytes] = { 0 };
    Bool16 result = QTSSRollingLog::FormatDate(theDateBuffer, false);
    
    char tempBuffer[1024] = { 0 };
    if (result)
    {
        StrPtrLen serverName;
        (void)QTSS_GetValuePtr(sServer, qtssSvrServerName, 0, (void**)&serverName.Ptr, &serverName.Len);
        StrPtrLen serverVersion;
        (void)QTSS_GetValuePtr(sServer, qtssSvrServerVersion, 0, (void**)&serverVersion.Ptr, &serverVersion.Len);
        qtss_sprintf(tempBuffer, sLogHeader, serverName.Ptr , serverVersion.Ptr, theDateBuffer, sLogTimeInGMT ? "GMT" : "local time");
        this->WriteToLog(tempBuffer, !kAllowLogToRoll);
    }
        
    return calendarTime;
}


void    WriteStartupMessage()
{
    if (sStartedUp)
        return;
        
    sStartedUp = true;
    
    //format a date for the startup time
    char theDateBuffer[QTSSRollingLog::kMaxDateBufferSizeInBytes];
    Bool16 result = QTSSRollingLog::FormatDate(theDateBuffer, false);
    
    char tempBuffer[1024];
    if (result)
        qtss_sprintf(tempBuffer, "#Remark: Streaming beginning STARTUP %s\n", theDateBuffer);
        
    // log startup message to error log as well.
    if ((result) && (sAccessLog != NULL))
        sAccessLog->WriteToLog(tempBuffer, kAllowLogToRoll);
}

void    WriteShutdownMessage()
{
    if (!sStartedUp)
        return;
        
    sStartedUp = false;
    
    //log shutdown message
    //format a date for the shutdown time
    char theDateBuffer[QTSSRollingLog::kMaxDateBufferSizeInBytes];
    Bool16 result = QTSSRollingLog::FormatDate(theDateBuffer, false);
    
    char tempBuffer[1024];
    if (result)
        qtss_sprintf(tempBuffer, "#Remark: Streaming beginning SHUTDOWN %s\n", theDateBuffer);

    if ( result && sAccessLog != NULL )
        sAccessLog->WriteToLog(tempBuffer, kAllowLogToRoll);
}


/*

Log file format recognized by Lariat Stats              
                
#Fields: c-ip date time c-dns cs-uri-stem c-starttime x-duration c-rate c-status c-playerid c-playerversion c-playerlanguage cs(User-Agent) cs(Referer) c-hostexe c-hostexever c-os c-osversion c-cpu filelength filesize avgbandwidth protocol transport audiocodec videocodec channelURL sc-bytes c-bytes s-pkts-sent c-pkts-received c-pkts-lost-client c-pkts-lost-net c-pkts-lost-cont-net c-resendreqs c-pkts-recovered-ECC c-pkts-recovered-resent c-buffercount c-totalbuffertime c-quality s-ip s-dns s-totalclients s-cpu-util                
e.g. 157.56.87.123 1998-01-19 22:53:59 foo.bar.com rtsp://ddelval1/56k_5min_1.mov 1 16 1 200 - 5.1.51.119 0409 - - dshow.exe 5.1.51.119 Windows_NT 4.0.0.1381 Pentium 78 505349 11000 RTSP UDP MPEG_Layer-3 MPEG-4_Video_High_Speed_Compressor_(MT) - 188387 188387 281 281 0 0 0 0 0 0 1 5 100 157.56.87.123 foo.bar.com 1 0                 

Notes:              
In the table below, W3C/Custom - refers to whether the fields are supported by the W3C file format or if it is a Custom  field              
All fields are space-delimited              
Fields not used by Lariat Stats should be present in the log file in some form, preferably a "-"                
Log files should be named according to the format: Filename.YYMMDDNNN.log, where Filename is specific to the server type, YYMMDD is the date of creation, and NNN is a 3 digit number used when there are multiple logs from the same date (e.g. 000, 001, 002, etc.)               

Field Name  Value   W3C/Custom  Example value   Used by Stats
                
c-ip    IP address of client    W3C 157.100.200.300 y
date    Date of the access  W3C 11-16-98    y
time    Time of the access (HH:MM:SS)   W3C 15:30:30    y
c-dns   Resolved dns of the client  W3C fredj.ford.com  n
cs-uri-stem     Requested file  W3C rtsp://server/sample.asf y
c-starttime     Start time  W3C 0   [in seconds, no fractions]  n
x-duration  Duration of the session (s) W3C 31   [in seconds, no fractions] y
c-rate  Rate file was played by client   Custom 1   [1= play, -5=rewind, +5=fforward]   n
c-status    http return code     Custom 200  [mapped to http/rtsp status codes; 200 is success, 404 file not found...]  y
c-playerid  unique player ID     Custom [a GUID value]  y
c-playerversion player version   Custom 3.0.0.1212      
c-playerlanguage    player language  Custom EN   [two letter country code]  y
cs(User-Agent)  user agent  W3C Mozilla/2.0+(compatible;+MSIE+3.0;+Windows 95)  - this is a sample user-agent string    n
cs(Referer)     referring URL   W3C http://www.gte.com  n
c-hostexe   host program     Custom iexplore.exe   [iexplore.exe, netscape.exe, dshow.exe, nsplay.exe, vb.exe, etcä]    n
c-hostexever    version  Custom 4.70.1215   y
c-os    os   Custom Windows   [Windows, Windows NT, Unix-[flavor], Mac-[flavor]]    y
c-osversion os version   Custom 4.0.0.1212  n
c-cpu   cpu type     Custom Pentium   [486, Pentium, Alpha %d, Mac?, Unix?] y
filelength  file length (s)  Custom 60   [in seconds, no fractions] y
filesize    file size (bytes)    Custom 86000   [ie: 86kbytes]  y
avgbandwidth         Custom 24300   [ie: 24.3kbps]  n
protocol         Custom RTSP  [rtsp, http]   n
transport        Custom UDP   [udp, tcp, or mc] n
audiocodec       Custom MPEG-Layer-3    y
videocodec       Custom MPEG4   y
channelURL       Custom http://server/channel.nsc   n
sc-bytes    bytes sent by server    W3C 30000   [30k bytes sent from the server to the client]  y
cs-bytes    bytes received by client    W3C 28000   [bytes received]    n
s-pkts-sent packets sent     Custom 55  y
c-pkts-recieved     packets received     Custom 50  n
c-pkts-lost-client  packets lost     Custom 5   y
c-pkts-lost-net          Custom 2   [renamed from erasures; refers to packets lost at the network layer]  n
c-pkts-lost-cont-net         Custom 2   [continuous packets lost at the network layer]  n
c-resendreqs    packets resent   Custom 5   y
c-pkts-recovered-ECC    packets resent successfully  Custom 1   [this refers to packets recovered in the client layer]  y
c-pkts-recovered-resent      Custom 5   [this refers to packets recovered via udp resend]   n
c-buffercount        Custom 1   n
c-totalbuffertime   seconds buffered     Custom 20   [in seconds]   y
c-quality   quality measurement  Custom 89   [in percent]   n
s-ip    server ip   W3C 155.12.1.234   [entered by the unicast server]  n
s-dns   server dns  W3C foo.company.com n
s-totalclients  total connections at time of access  Custom 201   [total clients]   n
s-cpu-util  cpu utilization at time of access    Custom 40   [in percent]   n
cs-uri-query        W3C language=EN&rate=1&CPU=486&protocol=RTSP&transport=UDP&quality=89&avgbandwidth=24300 n

*/
