gnupg/util/logger.c

/* logger.c  -	log functions
 *	Copyright (C) 1998, 1999 Free Software Foundation, Inc.
 *
 * This file is part of GnuPG.
 *
 * GnuPG 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 3 of the License, or
 * (at your option) any later version.
 *
 * GnuPG 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, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <errno.h>

#include "util.h"
#include "i18n.h"

#ifdef __VMS
# include <unistd.h>
# include "ttyio.h"
#endif /* def __VMS */

static char pidstring[15];
static char *pgm_name;
static int errorcount;
static int strict;
static FILE *logfp;

/****************
 * Set the logfile to use (not yet implemneted) or, if logfile is NULL,
 * the Fd where logoutputs should go.
 */
void
log_set_logfile( const char *name, int fd )
{
    if( name )
	BUG();

    if( logfp && logfp != stderr && logfp != stdout )
	fclose( logfp );
    if( fd == 1 )
	logfp = stdout;
    else if( fd == 2 )
	logfp = stderr;
    else
	logfp = fdopen( fd, "a" );
    if( !logfp ) {
	logfp = stderr;
	log_fatal("can't open fd %d for logging: %s\n", fd, strerror(errno));
    }
}

FILE *
log_stream()
{
    if( !logfp )
	logfp = stderr;
    return logfp;
}


void
log_set_name( const char *name )
{
    xfree(pgm_name);
    if( name )
	pgm_name = xstrdup(name);
    else
	pgm_name = NULL;
}

const char *
log_get_name(void)
{
    return pgm_name? pgm_name : "";
}


void
log_set_pid( int pid )
{
    if( pid )
	sprintf(pidstring,"[%u]", (unsigned)pid );
    else
	*pidstring = 0;
}

int
log_get_errorcount( int clear)
{
    int n = errorcount;
    if( clear )
	errorcount = 0;
    return n;
}

void
log_inc_errorcount()
{
  /* Protect agains overflow.  */
  if (errorcount < 30000)
    errorcount++;
}

int
log_set_strict(int val)
{
  int old=strict;
  strict=val;
  return old;
}

void
g10_log_print_prefix(const char *text)
{
#ifdef __VMS
    /* 2006-08-10 SMS.
       VMS terminal carriage control differs from that on UNIX, and one
       result is overwritten messages when terminal output is done
       through multiple file pointers (like logfp and ttyfp), even when
       they both are connected to the same terminal.  The accomodation
       attempted here is to initialize ttyfp before logfp, and if stderr
       and ttyfp are both terminals (presumably the same one), to set an
       unset logfp to ttyfp instead of to stderr.  */
    if (!logfp )
      {
        FILE *ttyfp_local;

        init_ttyfp();
        ttyfp_local = ttyfp_is ();
        if (isatty (fileno (stderr)) && isatty (fileno (ttyfp_local)))
          {
            logfp = ttyfp_local;
          }
      }
#endif /* def __VMS */

    if( !logfp )
	logfp = stderr;
    if( pgm_name )
	fprintf(logfp, "%s%s: %s", pgm_name, pidstring, text );
    else
	fprintf(logfp, "?%s: %s", pidstring, text );
#ifdef __riscos__
    fflush( logfp );
#endif /* __riscos__ */
}


void
g10_log_info( const char *fmt, ... )
{
    va_list arg_ptr ;

    g10_log_print_prefix("");
    va_start( arg_ptr, fmt ) ;
    vfprintf(logfp,fmt,arg_ptr) ;
    va_end(arg_ptr);
#ifdef __riscos__
    fflush( logfp );
#endif /* __riscos__ */
}


void
g10_log_warning( const char *fmt, ... )
{
    va_list arg_ptr ;

    if(strict)
      {
	log_inc_errorcount ();
	g10_log_print_prefix(_("ERROR: "));
      }
    else
      g10_log_print_prefix(_("WARNING: "));

    va_start( arg_ptr, fmt ) ;
    vfprintf(logfp,fmt,arg_ptr) ;
    va_end(arg_ptr);
#ifdef __riscos__
    fflush( logfp );
#endif /* __riscos__ */
}


void
g10_log_error( const char *fmt, ... )
{
    va_list arg_ptr ;

    g10_log_print_prefix("");
    va_start( arg_ptr, fmt ) ;
    vfprintf(logfp,fmt,arg_ptr) ;
    va_end(arg_ptr);
    log_inc_errorcount ();
#ifdef __riscos__
    fflush( logfp );
#endif /* __riscos__ */
}


void
g10_log_fatal( const char *fmt, ... )
{
    va_list arg_ptr ;

    g10_log_print_prefix("fatal: ");
    va_start( arg_ptr, fmt ) ;
    vfprintf(logfp,fmt,arg_ptr) ;
    va_end(arg_ptr);
    secmem_dump_stats();
#ifdef __riscos__
    fflush( logfp );
#endif /* __riscos__ */
    exit(2);
}

void
g10_log_bug( const char *fmt, ... )
{
    va_list arg_ptr ;

    putc('\n', stderr );
    g10_log_print_prefix("Ohhhh jeeee: ");
    va_start( arg_ptr, fmt ) ;
    vfprintf(stderr,fmt,arg_ptr) ;
    va_end(arg_ptr);
    fflush(stderr);
    secmem_dump_stats();
    abort();
}

#if defined (__riscos__) \
    || ( __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 ))
void
g10_log_bug0( const char *file, int line, const char *func )
{
    log_bug(_("... this is a bug (%s:%d:%s)\n"), file, line, func );
}
#else
void
g10_log_bug0( const char *file, int line )
{
    log_bug(_("you found a bug ... (%s:%d)\n"), file, line);
}
#endif

void
g10_log_debug( const char *fmt, ... )
{
    va_list arg_ptr ;

    g10_log_print_prefix("DBG: ");
    va_start( arg_ptr, fmt ) ;
    vfprintf(logfp,fmt,arg_ptr) ;
    va_end(arg_ptr);
#ifdef __riscos__
    fflush( logfp );
#endif /* __riscos__ */
}



void
g10_log_hexdump( const char *text, const char *buf, size_t len )
{
    int i;

    g10_log_print_prefix(text);
    for(i=0; i < len; i++ )
	fprintf(logfp, " %02X", ((const byte*)buf)[i] );
    fputc('\n', logfp);
#ifdef __riscos__
    fflush( logfp );
#endif /* __riscos__ */
}