src/logfile.c File Reference

#include <eggdrop/eggdrop.h>
#include <unistd.h>
#include "core_config.h"
#include "terminal.h"
#include "logfile.h"

Go to the source code of this file.

Functions
static int	logfile_minutely ()
static int	logfile_5minutely ()
static int	logfile_cycle ()
static void	check_logsizes ()
static void	flushlog (logfile_t *log, char *timestamp)
static int	on_putlog (int flags, const char *chan, const char *text, int len)
void	logfile_init (void)
void	logfile_shutdown (void)
char *	logfile_add (char *modes, char *chan, char *fname)
int	logfile_del (char *filename)
void	flushlogs ()
Variables
static const char	rcsid [] = "$Id: logfile.c,v 1.51 2006-11-14 14:51:24 sven Exp $"
static logfile_t *	logfiles = NULL
static int	nlogfiles = 0
int	backgrd
int	use_stderr
int	terminal_mode
int	terminal_enabled = 0
time_t	now
static script_command_t	log_script_cmds []

---

Function Documentation

static void check_logsizes

(

)

[static]

Definition at line 298 of file logfile.c.

References _, core_config, egg_mprintf(), logfile_t::filename, logfile_t::fp, logging_t::keep_all, LOG_MISC, core_config_t::logging, logging_t::max_size, movefile(), nlogfiles, and putlog().

Referenced by logfile_5minutely(), and logfile_minutely().

{
  int size, i;
  char *newfname;

  if (core_config.logging.keep_all || core_config.logging.max_size <= 0) return;

  for (i = 0; i < nlogfiles; i++) {
    logfile_t *log = &logfiles[i];
    
    size = ftell(log->fp) / 1024; /* Size in kilobytes. */
    if (size < core_config.logging.max_size) continue;

    /* It's too big. */
    putlog(LOG_MISC, "*", _("Cycling logfile %s: over max-logsize (%d kilobytes)."), log->filename, size);
    fclose(log->fp);

    newfname = egg_mprintf("%s.yesterday", log->filename);
    unlink(newfname);
    movefile(log->filename, newfname);
    free(newfname);
  }
}

static void flushlog	(	logfile_t *	log,
		char *	timestamp
	)			[static]

Definition at line 322 of file logfile.c.

References _, logfile_t::fp, logfile_t::last_msg, logfile_t::repeats, and str_redup().

Referenced by flushlogs(), and logfile_del().

{
  if (log->repeats) {
    fprintf(log->fp, "%s", timestamp);
    fprintf(log->fp, _("Last message repeated %d time(s).\n"), log->repeats);
    log->repeats = 0;
    str_redup(&log->last_msg, "");
  }
  fflush(log->fp);
}

void flushlogs

(

)

Definition at line 335 of file logfile.c.

References flushlog(), nlogfiles, and timer_get_timestamp().

Referenced by fatal(), logfile_5minutely(), logfile_cycle(), logfile_minutely(), and logfile_shutdown().

{
  char *ts;
  int i;

  ts = timer_get_timestamp();
  for (i = 0; i < nlogfiles; i++) {
    flushlog(&logfiles[i], ts);
  }
}

static int logfile_5minutely

(

)

[static]

Definition at line 115 of file logfile.c.

References check_logsizes(), core_config, flushlogs(), core_config_t::logging, and logging_t::quick.

Referenced by logfile_init(), and logfile_shutdown().

{
  if (!core_config.logging.quick) {
    flushlogs();
    check_logsizes();
  }
  return(0);
}

char* logfile_add	(	char *	modes,
		char *	chan,
		char *	fname
	)

Definition at line 158 of file logfile.c.

References logfile_t::chname, logfile_t::filename, logfile_t::fp, logfile_t::last_msg, LOG_ALL, logfile_del(), logfile_t::mask, and nlogfiles.

Referenced by logfile_init().

{
  FILE *fp;
  logfile_t *log;

  /* Get rid of any duplicates. */
  logfile_del(fname);

  /* Test the filename. */
  fp = fopen(fname, "a");
  if (!fp) return("");
  
  logfiles = realloc(logfiles, (nlogfiles + 1) * sizeof(*logfiles));
      
  log = &logfiles[nlogfiles++];
  memset(log, 0, sizeof(*log));
  log->filename = strdup(fname);
  log->chname = strdup(chan);
  log->last_msg = strdup("");
  log->mask = LOG_ALL;
  log->fp = fp;

  return (log->filename);
}

static int logfile_cycle

(

)

[static]

Definition at line 124 of file logfile.c.

References _, core_config, egg_mprintf(), logfile_t::filename, flushlogs(), logfile_t::fp, logging_t::keep_all, LOG_MISC, logfile_del(), core_config_t::logging, movefile(), nlogfiles, now, putlog(), and logging_t::suffix.

Referenced by logfile_minutely().

{
  logfile_t *log;
  int i;
  char suffix[32];
  char *newfname;

  putlog(LOG_MISC, "*", _("Cycling logfiles..."));
  flushlogs();

  /* Determine suffix for cycled logfiles. */
  if (core_config.logging.keep_all) {
    strftime(suffix, 32, core_config.logging.suffix, localtime(&now));
  }

  for (i = nlogfiles - 1; i >= 0; i--) {
    log = &logfiles[i];

    fclose(log->fp);

    if (core_config.logging.keep_all) newfname = egg_mprintf("%s%s", log->filename, suffix);
    else newfname = egg_mprintf("%s.yesterday", log->filename);

    unlink(newfname);
    movefile(log->filename, newfname);
    free(newfname);

    log->fp = fopen(log->filename, "a");
    if (!log->fp) logfile_del(log->filename);
  }
  
  return(0);
}

int logfile_del

(

char *

filename

)

Definition at line 183 of file logfile.c.

References logfile_t::filename, flushlog(), logfile_t::fp, logfile_t::last_msg, nlogfiles, NULL, and timer_get_timestamp().

Referenced by logfile_add(), and logfile_cycle().

{
  logfile_t *log;
  int i;

  log = NULL;
  for (i = 0; i < nlogfiles; i++) {
    log = &logfiles[i];
    if (!strcmp(log->filename, filename)) break;
    log = NULL;
  }

  if (log == NULL) return(-1);
    
  if (log->fp) {
    flushlog(log, timer_get_timestamp());
    fclose(log->fp);
  }

  if (log->last_msg) free(log->last_msg);
  if (log->filename) free(log->filename);

  if (nlogfiles == 1) {
    free(logfiles);
    logfiles = NULL;
  } else {    
    memmove(logfiles + i, logfiles + i + 1, (nlogfiles - i - 1) * sizeof(logfile_t));
    logfiles = realloc(logfiles, (nlogfiles - 1) * sizeof(logfile_t));
  }

  nlogfiles--;

  return(0);
}

void logfile_init

(

void

)

Definition at line 54 of file logfile.c.

References bind_add_simple(), config_get_root(), config_get_str(), config_lookup_section(), logfile_5minutely(), logfile_add(), logfile_minutely(), NULL, on_putlog(), and script_create_commands().

Referenced by core_init().

{
  void *root, *node;
  char *filename, *chname, *mask;
  int i;

  script_create_commands(log_script_cmds);
  bind_add_simple("log", NULL, NULL, on_putlog);
  bind_add_simple("event", NULL, "minutely", logfile_minutely);
  bind_add_simple("event", NULL, "5minutely", logfile_5minutely);

  root = config_get_root("eggdrop");
  node = config_lookup_section(root, "eggdrop.logging.logfiles", 0, NULL);
  for (i = 0; ; i++) {
    config_get_str(&filename, node, "logfile", i, "filename", 0, NULL);
    config_get_str(&chname, node, "logfile", i, "channel", 0, NULL);
    config_get_str(&mask, node, "logfile", i, "mask", 0, NULL);
    if (!filename || !chname || !mask) break;
    logfile_add(mask, chname, filename);
  }
}

static int logfile_minutely

(

)

[static]

Definition at line 97 of file logfile.c.

References check_logsizes(), core_config, flushlogs(), logfile_cycle(), core_config_t::logging, now, nowtm, logging_t::quick, and logging_t::switch_at.

Referenced by logfile_init(), and logfile_shutdown().

{
  struct tm *nowtm;
  int miltime;

  if (core_config.logging.quick) {
    flushlogs();
    check_logsizes();
  }

  nowtm = localtime(&now);
  miltime = 100 * nowtm->tm_hour + nowtm->tm_min;

  if (miltime == core_config.logging.switch_at) logfile_cycle();

  return(0);
}

void logfile_shutdown

(

void

)

Definition at line 76 of file logfile.c.

References bind_rem_simple(), config_get_root(), config_lookup_section(), config_set_str(), flushlogs(), logfile_5minutely(), logfile_minutely(), nlogfiles, NULL, on_putlog(), and script_delete_commands().

Referenced by core_shutdown_or_restart().

{
  void *root, *node;
  int i;

  flushlogs();
  
  root = config_get_root("eggdrop");
  node = config_lookup_section(root, "eggdrop.logging.logfiles", 0, NULL);
  for (i = 0; i < nlogfiles; i++) {
    config_set_str(logfiles[i].filename, node, "logfile", i, "filename", 0, NULL);
    config_set_str(logfiles[i].chname, node, "logfile", i, "channel", 0, NULL);
    config_set_str("*", node, "logfile", i, "mask", 0, NULL);
  }

  bind_rem_simple("log", NULL, NULL, on_putlog);
  bind_rem_simple("event", NULL, "minutely", logfile_minutely);
  bind_rem_simple("event", NULL, "5minutely", logfile_5minutely);
  script_delete_commands(log_script_cmds);
}

static int on_putlog	(	int	flags,
		const char *	chan,
		const char *	text,
		int	len
	)			[static]

Definition at line 218 of file logfile.c.

References _, backgrd, logfile_t::chname, logfile_t::filename, logfile_t::fname, logfile_t::fp, irccmp(), logfile_t::last_msg, LOG_MISC, LOG_STATE_DISABLED, LOG_STATE_ENABLED, logfile_t::mask, nlogfiles, now, NULL, partymember_lookup(), putlog(), logfile_t::repeats, logfile_t::state, str_redup(), terminal_enabled, terminal_mode, TERMINAL_NICK, timer_get_timestamp(), and use_stderr.

Referenced by logfile_init(), and logfile_shutdown().

{
  char *ts;
  int i;

  ts = timer_get_timestamp();
  for (i = nlogfiles - 1; i >= 0; i--) {
    logfile_t *log = &logfiles[i];
    
    /* If this log is disabled, skip it */
    if (log->state != LOG_STATE_ENABLED)
      continue;

    /* If this log doesn't match, skip it. */
    if (!(log->mask & flags)) {
      continue;
    }

    if (chan[0] != '*' && log->chname[0] != '*' && irccmp(chan, log->chname)) continue;
    
    /* If it's a repeat message, don't write it again. */
    if (log->last_msg && !strcasecmp(text, log->last_msg)) {
      log->repeats++;
      continue;
    }


    /* If there was a repeated message, write the count. */
    if (log->repeats) {
      fprintf(log->fp, "%s", ts);
      fprintf(log->fp, _("Last message repeated %d time(s).\n"), log->repeats);
      log->repeats = 0;
    }

    /* Save this msg to check for repeats next time. */
    str_redup(&log->last_msg, text);

    if (log->fp == NULL) {
      if (log->fname == NULL) {
        char buf[1024];
        time_t now;

        now = time(NULL);
        strftime(buf, sizeof(buf), log->filename, localtime(&now));
        log->fname = strdup(buf);
      } 

      log->fp = fopen(log->fname, "a+");
      if (log->fp == NULL) {
        log->state = LOG_STATE_DISABLED;
        putlog(LOG_MISC, "*", _("Failed to open log file: %s"), log->fname);
        putlog(LOG_MISC, "*", _("  Check if directory (if any) exists and is read- and writeable."));
        continue;
      }
    }

    /* Now output to the file. */
    fprintf(log->fp, "%s%s\n", ts, text);
  }

  if (!backgrd || use_stderr) {
  
    if (terminal_mode) {
      /* check if HQ is on console. If yes we disable
       * output to stdout since otherwise everything would
       * be printed out twice. */   
      if (!terminal_enabled) {
        terminal_enabled = (partymember_lookup(TERMINAL_NICK, NULL, -1) != NULL);
      }
      if (terminal_enabled)
        return 0;

    }
    
    fprintf (stdout, "%s %s%s\n", chan, ts, text);
  }
    
  return(0);
}

---

Variable Documentation

int backgrd

Definition at line 61 of file main.c.

Referenced by core_init(), do_args(), and on_putlog().

script_command_t log_script_cmds[] [static]

Initial value:

 {
  {"", "logfile", logfile_add, NULL, 3, "sss", "modes chan filename", SCRIPT_STRING, 0},  
  {0}
}

Definition at line 49 of file logfile.c.

logfile_t* logfiles = NULL [static]

Definition at line 32 of file logfile.c.

int nlogfiles = 0 [static]

Definition at line 33 of file logfile.c.

Referenced by check_logsizes(), flushlogs(), logfile_add(), logfile_cycle(), logfile_del(), logfile_shutdown(), and on_putlog().

time_t now

Definition at line 72 of file main.c.

Referenced by chanserv_update_stats(), check_expired_bans(), check_expired_exempts(), check_expired_invites(), cleanup_old_members(), cmd_files(), cmd_mkdir(), cmd_pls_mask(), core_init(), core_secondly(), date_timezone(), dcc_files(), dcc_files_pass(), dcc_send_info(), disp_dcc_files_pass(), display_ban(), display_exempt(), display_invite(), filedb_add(), filedb_initdb(), filedb_open(), filedb_timestamp(), filedb_update(), filesys_DCC_CHAT(), filesys_dcc_send_hostresolved(), gotpong(), logfile_cycle(), logfile_minutely(), main(), modefight_cleanup(), NamedDay(), NamedMonth(), on_putlog(), party_timers(), raw_dcc_resend_send(), script_newsomething(), script_setlaston(), script_timer_info(), server_secondly(), tcl_mkdir(), tell_bans(), tell_exempts(), tell_invites(), u_addmask(), and write_channels().

const char rcsid[] = "$Id: logfile.c,v 1.51 2006-11-14 14:51:24 sven Exp $" [static]

Definition at line 22 of file logfile.c.

int terminal_enabled = 0

Definition at line 36 of file logfile.c.

Referenced by on_putlog(), and terminal_shutdown().

int terminal_mode

Definition at line 63 of file main.c.

Referenced by core_init(), core_shutdown_or_restart(), do_args(), and on_putlog().

int use_stderr

Definition at line 75 of file main.c.

Referenced by on_putlog().