OOLogOutputHandler.m File Reference

import "OOLogOutputHandler.h"
import "OOLogging.h"
import "OOAsyncQueue.h"
#include <stdlib.h>
#include <stdio.h>
import "NSThreadOOExtensions.h"
import "NSFileManagerOOExtensions.h"
#include <SDL.h>
#include <dlfcn.h>

Include dependency graph for OOLogOutputHandler.m:

Go to the source code of this file.

Classes
class	OOAsyncLogger

Macros
#define	OOLOG_POISON_NSLOG   0
#define	SET_CRASH_REPORTER_INFO   1
#define	kFlushInterval   2.0

Typedefs
typedef void(*	LogCStringFunctionProc) (const char *string, unsigned length, BOOL withSyslogBanner)
typedef LogCStringFunctionProc(*	LogCStringFunctionGetterProc) (void)
typedef void(*	LogCStringFunctionSetterProc) (LogCStringFunctionProc)

Enumerations
enum	{ kConditionReadyToDealloc = 1 , kConditionWorking }

Functions
static void	InitCrashReporterInfo (void)
static void	SetCrashReporterInfo (const char *info)
static void	LoadLogCStringFunctions (void)
static void	OONSLogCStringFunction (const char *string, unsigned length, BOOL withSyslogBanner)
static NSString *	GetAppName (void)
static BOOL	DirectoryExistCreatingIfNecessary (NSString *path)
void	OOLogOutputHandlerInit (void)
void	OOLogOutputHandlerClose (void)
void	OOLogOutputHandlerStartLoggingToStdout ()
void	OOLogOutputHandlerStopLoggingToStdout ()
void	OOLogOutputHandlerPrint (NSString *string)
NSString *	OOLogHandlerGetLogPath (void)
void	OOLogOutputHandlerChangeLogFile (NSString *newLogName)
static void	ExcludeFromTimeMachine (NSString *path)
NSString *	OOLogHandlerGetLogBasePath (void)

Variables
static BOOL	sCrashReporterInfoAvailable = NO
static LogCStringFunctionGetterProc	_NSLogCStringFunction = NULL
static LogCStringFunctionSetterProc	_NSSetLogCStringFunction = NULL
static LogCStringFunctionProc	sDefaultLogCStringFunction = NULL
static BOOL	sInited = NO
static BOOL	sWriteToStderr = YES
static BOOL	sWriteToStdout = NO
static BOOL	sSaturated = NO
static OOAsyncLogger *	sLogger = nil
static NSString *	sLogFileName = @"@"Latest.log"
static char **	sCrashReporterInfo = NULL
static char *	sOldCrashReporterInfo = NULL
static NSLock *	sCrashReporterInfoLock = nil

Macro Definition Documentation

kFlushInterval

#define kFlushInterval   2.0

Definition at line 87 of file OOLogOutputHandler.m.

OOLOG_POISON_NSLOG

#define OOLOG_POISON_NSLOG   0

Definition at line 30 of file OOLogOutputHandler.m.

SET_CRASH_REPORTER_INFO

#define SET_CRASH_REPORTER_INFO   1

Definition at line 51 of file OOLogOutputHandler.m.

Typedef Documentation

LogCStringFunctionGetterProc

typedef LogCStringFunctionProc(* LogCStringFunctionGetterProc) (void)

Definition at line 63 of file OOLogOutputHandler.m.

LogCStringFunctionProc

typedef void(* LogCStringFunctionProc) (const char *string, unsigned length, BOOL withSyslogBanner)

Definition at line 62 of file OOLogOutputHandler.m.

LogCStringFunctionSetterProc

typedef void(* LogCStringFunctionSetterProc) (LogCStringFunctionProc)

Definition at line 64 of file OOLogOutputHandler.m.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kConditionReadyToDealloc
kConditionWorking

Definition at line 237 of file OOLogOutputHandler.m.

{
    kConditionReadyToDealloc = 1,
    kConditionWorking
};

Function Documentation

DirectoryExistCreatingIfNecessary()

BOOL DirectoryExistCreatingIfNecessary ( NSString * path )

static

Definition at line 550 of file OOLogOutputHandler.m.

{
    BOOL                exists, directory;
    NSFileManager       *fmgr =  [NSFileManager defaultManager];
    
    exists = [fmgr fileExistsAtPath:path isDirectory:&directory];
    
    if (exists && !directory)
    {
        NSLog(@"Log setup: expected %@ to be a folder, but it is a file.", path);
        return NO;
    }
    if (!exists)
    {
        if (![fmgr oo_createDirectoryAtPath:path attributes:nil])
        {
            NSLog(@"Log setup: could not create folder %@.", path);
            return NO;
        }
    }
    
    return YES;
}

References nil, and NSLog.

Referenced by OOLogHandlerGetLogBasePath().

Here is the caller graph for this function:

ExcludeFromTimeMachine()

void ExcludeFromTimeMachine ( NSString * path )

static

Definition at line 576 of file OOLogOutputHandler.m.

{
    OSStatus (*CSBackupSetItemExcluded)(NSURL *item, Boolean exclude, Boolean excludeByPath) = NULL;
    CFBundleRef carbonCoreBundle = CFBundleGetBundleWithIdentifier(CFSTR("com.apple.CoreServices.CarbonCore"));
    if (carbonCoreBundle)
    {
        CSBackupSetItemExcluded = CFBundleGetFunctionPointerForName(carbonCoreBundle, CFSTR("CSBackupSetItemExcluded"));
        if (CSBackupSetItemExcluded != NULL)
        {
            (void)CSBackupSetItemExcluded([NSURL fileURLWithPath:path], YES, NO);
        }
    }
}

Referenced by OOLogHandlerGetLogBasePath().

Here is the caller graph for this function:

GetAppName()

NSString * GetAppName ( void )

static

Definition at line 590 of file OOLogOutputHandler.m.

{
    static NSString     *appName = nil;
    NSBundle            *bundle = nil;
 
    if (appName == nil)
    {
        bundle = [NSBundle mainBundle];
        appName = [bundle objectForInfoDictionaryKey:@"CFBundleName"];
        if (appName == nil)  appName = [bundle bundleIdentifier];
        if (appName == nil)  appName = @"<unknown application>";
        [appName retain];
    }
 
    return appName;
}

References nil.

InitCrashReporterInfo()

void InitCrashReporterInfo ( void )

static

Definition at line 663 of file OOLogOutputHandler.m.

{
    sCrashReporterInfo = dlsym(RTLD_DEFAULT, "__crashreporter_info__");
    if (sCrashReporterInfo != NULL)
    {
        sCrashReporterInfoLock = [[NSLock alloc] init];
        if (sCrashReporterInfoLock != nil)
        {
            sCrashReporterInfoAvailable = YES;
        }
        else
        {
            sCrashReporterInfo = NULL;
        }
    }
}

References nil, sCrashReporterInfo, sCrashReporterInfoAvailable, and sCrashReporterInfoLock.

Referenced by OOLogOutputHandlerInit().

Here is the caller graph for this function:

LoadLogCStringFunctions()

void LoadLogCStringFunctions ( void )

static

Definition at line 508 of file OOLogOutputHandler.m.

{
    CFBundleRef                     foundationBundle = NULL;
    LogCStringFunctionGetterProc    getter = NULL;
    LogCStringFunctionSetterProc    setter = NULL;
    
    foundationBundle = CFBundleGetBundleWithIdentifier(CFSTR("com.apple.Foundation"));
    if (foundationBundle != NULL)
    {
        getter = CFBundleGetFunctionPointerForName(foundationBundle, CFSTR("_NSLogCStringFunction"));
        setter = CFBundleGetFunctionPointerForName(foundationBundle, CFSTR("_NSSetLogCStringFunction"));
        
        if (getter != NULL && setter != NULL)
        {
            _NSLogCStringFunction = getter;
            _NSSetLogCStringFunction = setter;
        }
    }
}

References _NSLogCStringFunction, and _NSSetLogCStringFunction.

Referenced by OOLogOutputHandlerInit().

Here is the caller graph for this function:

OOLogHandlerGetLogBasePath()

NSString * OOLogHandlerGetLogBasePath

(

void

)

Definition at line 608 of file OOLogOutputHandler.m.

{
    static NSString     *basePath = nil;
 
    if (basePath == nil)
    {
        const char *logdirEnv = SDL_getenv("OO_LOGSDIR");
 
        if (logdirEnv)
        {
            basePath = [NSString stringWithUTF8String:logdirEnv];
        }
        else
        {
#if OOLITE_MAC_OS_X
            // ~/Library
            basePath = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) objectAtIndex:0];
#elif OOLITE_LINUX
            // ~
            basePath = NSHomeDirectory();
 
            // ~/.Oolite
            basePath = [basePath stringByAppendingPathComponent:@".Oolite"];
            if (!DirectoryExistCreatingIfNecessary(basePath))  return nil;
#elif OOLITE_WINDOWS
            // <Install path>\Oolite
            basePath = NSHomeDirectory();
#endif
 
            // .../Logs
            basePath = [basePath stringByAppendingPathComponent:@"Logs"];
            if (!DirectoryExistCreatingIfNecessary(basePath))  return nil;
 
#if OOLITE_MAC_OS_X
            // ~/Library/Logs/Oolite
            basePath = [basePath stringByAppendingPathComponent:GetAppName()];
            if (!DirectoryExistCreatingIfNecessary(basePath))  return nil;
#endif
        }
#if OOLITE_MAC_OS_X
        ExcludeFromTimeMachine(basePath);
#endif
        [basePath retain];
    }
 
    return basePath;
}

References DirectoryExistCreatingIfNecessary(), ExcludeFromTimeMachine(), and nil.

Referenced by ResourceManager::diagnosticFileLocation, OODockTilePlugIn::logFolderPath, and GameController::validateMenuItem:.

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogHandlerGetLogPath()

NSString * OOLogHandlerGetLogPath

(

void

)

Definition at line 221 of file OOLogOutputHandler.m.

{
    return [OOLogHandlerGetLogBasePath() stringByAppendingPathComponent:sLogFileName];  
}

Referenced by OOAsyncLogger::init, OpenLogFile(), and OOAsyncLogger::startLogging.

Here is the caller graph for this function:

OOLogOutputHandlerChangeLogFile()

void OOLogOutputHandlerChangeLogFile

(

NSString *

newLogName

)

Definition at line 227 of file OOLogOutputHandler.m.

{
    if (![sLogFileName isEqual:newLogName])
    {
        sLogFileName = [newLogName copy];
        [sLogger changeFile];
    }
}

References OOAsyncLogger::changeFile, and sLogFileName.

Referenced by SwitchLogFile().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogOutputHandlerClose()

void OOLogOutputHandlerClose

(

void

)

Definition at line 162 of file OOLogOutputHandler.m.

{
    if (sInited)
    {
        sWriteToStderr = YES;
        sInited = NO;
        
        [sLogger endLogging];
        DESTROY(sLogger);
        
#if OOLITE_MAC_OS_X
        if (sDefaultLogCStringFunction != NULL && _NSSetLogCStringFunction != NULL)
        {
            _NSSetLogCStringFunction(sDefaultLogCStringFunction);
            sDefaultLogCStringFunction = NULL;
        }
#elif GNUSTEP
        NSRecursiveLock *lock = GSLogLock();
        [lock lock];
        _NSLog_printf_handler = NULL;
        [lock unlock];
#endif
    }
}

References _NSSetLogCStringFunction, DESTROY, OOAsyncLogger::endLogging, sDefaultLogCStringFunction, sInited, sLogger, and sWriteToStderr.

Referenced by OOLoggingTerminate(), and OOLogOutputHandlerInit().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogOutputHandlerInit()

void OOLogOutputHandlerInit

(

void

)

Definition at line 120 of file OOLogOutputHandler.m.

{
    if (sInited)  return;
    
#if SET_CRASH_REPORTER_INFO
    InitCrashReporterInfo();
#endif
    
    sLogger = [[OOAsyncLogger alloc] init];
    sInited = YES;
    
    if (sLogger != nil)
    {
        sWriteToStderr = [[NSUserDefaults standardUserDefaults] boolForKey:@"logging-echo-to-stderr"];
    }
    else
    {
        sWriteToStderr = YES;
    }
    
#if OOLITE_MAC_OS_X
    LoadLogCStringFunctions();
    if (_NSSetLogCStringFunction != NULL)
    {
        sDefaultLogCStringFunction = _NSLogCStringFunction();
        _NSSetLogCStringFunction(OONSLogCStringFunction);
    }
    else
    {
        OOLog(@"logging.nsLogFilter.install.failed", @"Failed to install NSLog() filter; system messages will not be logged in log file.");
    }
#elif GNUSTEP
    NSRecursiveLock *lock = GSLogLock();
    [lock lock];
    _NSLog_printf_handler = OONSLogPrintfHandler;
    [lock unlock];
#endif
    
    atexit(OOLogOutputHandlerClose);
}

References _NSLogCStringFunction, _NSSetLogCStringFunction, InitCrashReporterInfo(), LoadLogCStringFunctions(), nil, OOLog, OOLogOutputHandlerClose(), OONSLogCStringFunction(), sDefaultLogCStringFunction, sInited, sLogger, and sWriteToStderr.

Referenced by OOLoggingInit().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogOutputHandlerPrint()

void OOLogOutputHandlerPrint

(

NSString *

string

)

Definition at line 196 of file OOLogOutputHandler.m.

{
    if (sInited && sLogger != nil && !sWriteToStdout)  [sLogger asyncLogMessage:string];
    
    BOOL doCStringStuff = sWriteToStderr || sWriteToStdout;
#if SET_CRASH_REPORTER_INFO
    doCStringStuff = doCStringStuff || sCrashReporterInfoAvailable;
#endif
    
    if (doCStringStuff)
    {
        const char *cStr = [[string stringByAppendingString:@"\n"] UTF8String];
        if (sWriteToStdout)
            fputs(cStr, stdout);
        else if (sWriteToStderr)
            fputs(cStr, stderr);
        
#if SET_CRASH_REPORTER_INFO
        if (sCrashReporterInfoAvailable)  SetCrashReporterInfo(cStr);
#endif
    }
    
}

References OOAsyncLogger::asyncLogMessage:, nil, sCrashReporterInfoAvailable, SetCrashReporterInfo(), sInited, sLogger, sWriteToStderr, and sWriteToStdout.

Referenced by OOLogInsertMarker(), OOLogInternal_(), and OOLogWithFunctionFileAndLineAndArguments().

Here is the call graph for this function:

Here is the caller graph for this function:

OOLogOutputHandlerStartLoggingToStdout()

void OOLogOutputHandlerStartLoggingToStdout

(

void

)

Definition at line 187 of file OOLogOutputHandler.m.

{
    sWriteToStdout = true;
}

References sWriteToStdout.

OOLogOutputHandlerStopLoggingToStdout()

void OOLogOutputHandlerStopLoggingToStdout

(

void

)

Definition at line 191 of file OOLogOutputHandler.m.

{
    sWriteToStdout = false;
}

References sWriteToStdout.

OONSLogCStringFunction()

void OONSLogCStringFunction ( const char * string, unsigned length, BOOL withSyslogBanner )

static

Definition at line 529 of file OOLogOutputHandler.m.

{
    if (OOLogWillDisplayMessagesInClass(@"system"))
    {
        OOLogWithFunctionFileAndLine(@"system", NULL, NULL, 0, @"%s", string);
    }
}

References OOLogWillDisplayMessagesInClass(), and OOLogWithFunctionFileAndLine().

Referenced by OOLogOutputHandlerInit().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCrashReporterInfo()

void SetCrashReporterInfo ( const char * info )

static

Definition at line 680 of file OOLogOutputHandler.m.

{
    char                    *copy = NULL, *old = NULL;
    
    /*  Don't do anything if setup failed or the string is NULL or empty.
        (The NULL and empty checks may not be desirable in other uses.)
    */
    if (!sCrashReporterInfoAvailable || info == NULL || *info == '\0')  return;
    
    // Copy the string, which we assume to be dynamic...
    copy = strdup(info);
    if (copy == NULL)  return;
    
    /*  ...and swap it in.
        Note that we keep a separate pointer to the old value, in case
        something else overwrites __crashreporter_info__.
    */
    [sCrashReporterInfoLock lock];
    *sCrashReporterInfo = copy;
    old = sOldCrashReporterInfo;
    sOldCrashReporterInfo = copy;
    [sCrashReporterInfoLock unlock];
    
    // Delete our old string.
    if (old != NULL)  free(old);
}

References sCrashReporterInfo, sCrashReporterInfoAvailable, and sOldCrashReporterInfo.

Referenced by OOLogOutputHandlerPrint().

Here is the caller graph for this function:

Variable Documentation

_NSLogCStringFunction

LogCStringFunctionGetterProc _NSLogCStringFunction = NULL

static

Definition at line 66 of file OOLogOutputHandler.m.

Referenced by LoadLogCStringFunctions(), and OOLogOutputHandlerInit().

_NSSetLogCStringFunction

LogCStringFunctionSetterProc _NSSetLogCStringFunction = NULL

static

Definition at line 67 of file OOLogOutputHandler.m.

Referenced by LoadLogCStringFunctions(), OOLogOutputHandlerClose(), and OOLogOutputHandlerInit().

sCrashReporterInfo

char** sCrashReporterInfo = NULL

static

Definition at line 658 of file OOLogOutputHandler.m.

Referenced by InitCrashReporterInfo(), and SetCrashReporterInfo().

sCrashReporterInfoAvailable

BOOL sCrashReporterInfoAvailable = NO

static

Definition at line 57 of file OOLogOutputHandler.m.

Referenced by InitCrashReporterInfo(), OOLogOutputHandlerPrint(), and SetCrashReporterInfo().

sCrashReporterInfoLock

NSLock* sCrashReporterInfoLock = nil

static

Definition at line 660 of file OOLogOutputHandler.m.

Referenced by InitCrashReporterInfo().

sDefaultLogCStringFunction

LogCStringFunctionProc sDefaultLogCStringFunction = NULL

static

Definition at line 74 of file OOLogOutputHandler.m.

Referenced by OOLogOutputHandlerClose(), and OOLogOutputHandlerInit().

sInited

BOOL sInited = NO

static

Definition at line 112 of file OOLogOutputHandler.m.

sLogFileName

NSString* sLogFileName = @"@"Latest.log"

static

Definition at line 117 of file OOLogOutputHandler.m.

Referenced by OOLogOutputHandlerChangeLogFile().

sLogger

OOAsyncLogger* sLogger = nil

static

Definition at line 116 of file OOLogOutputHandler.m.

Referenced by OOLogOutputHandlerClose(), OOLogOutputHandlerInit(), and OOLogOutputHandlerPrint().

sOldCrashReporterInfo

char* sOldCrashReporterInfo = NULL

static

Definition at line 659 of file OOLogOutputHandler.m.

Referenced by SetCrashReporterInfo().

sSaturated

BOOL sSaturated = NO

static

Definition at line 115 of file OOLogOutputHandler.m.

Referenced by OOAsyncLogger::asyncLogMessage:, and OOAsyncLogger::loggerThread.

sWriteToStderr

BOOL sWriteToStderr = YES

static

Definition at line 113 of file OOLogOutputHandler.m.

Referenced by OOAsyncLogger::changeFile, OOLogOutputHandlerClose(), OOLogOutputHandlerInit(), and OOLogOutputHandlerPrint().

sWriteToStdout

BOOL sWriteToStdout = NO

static

Definition at line 114 of file OOLogOutputHandler.m.

Referenced by OOLogOutputHandlerPrint(), OOLogOutputHandlerStartLoggingToStdout(), and OOLogOutputHandlerStopLoggingToStdout().