lib/logging.c

   1 /*
   2    Provides a log file to ease tracing the program.
   3
   4    Copyright (C) 2006, 2009 Free Software Foundation, Inc.
   5
   6    Written: 2006 Roland Illig <roland.illig@gmx.de>.
   7
   8    This file is part of the Midnight Commander.
   9
  10    The Midnight Commander is free software; you can redistribute it
  11    and/or modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2 of the
  13    License, or (at your option) any later version.
  14
  15    The Midnight Commander is distributed in the hope that it will be
  16    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  17    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  23    MA 02110-1301, USA.
  24  */
  25
  26 /** \file logging.c
  27  *  \brief Source: provides a log file to ease tracing the program
  28  */
  29
  30 #include <config.h>
  31
  32 #include <stdarg.h>
  33 #include <stdio.h>
  34
  35 #include "lib/global.h"
  36 #include "lib/mcconfig.h"
  37 #include "lib/fileloc.h"
  38
  39 #include "src/main.h"           /* home_dir */
  40
  41 #include "logging.h"
  42
  43 /*** global variables ****************************************************************************/
  44
  45 /*** file scope macro definitions ****************************************************************/
  46
  47 /*** file scope type declarations ****************************************************************/
  48
  49 /*** file scope variables ************************************************************************/
  50
  51 /*** file scope functions ************************************************************************/
  52 /* --------------------------------------------------------------------------------------------- */
  53
  54 static gboolean
  55 is_logging_enabled (void)
  56 {
  57     static gboolean logging_initialized = FALSE;
  58     static gboolean logging_enabled = FALSE;
  59
  60     if (!logging_initialized)
  61     {
  62         logging_enabled = mc_config_get_bool (mc_main_config,
  63                                               CONFIG_APP_SECTION, "development.enable_logging",
  64                                               FALSE);
  65         logging_initialized = TRUE;
  66     }
  67     return logging_enabled;
  68 }
  69
  70 /* --------------------------------------------------------------------------------------------- */
  71 /*** public functions ****************************************************************************/
  72 /* --------------------------------------------------------------------------------------------- */
  73
  74 void
  75 mc_log (const char *fmt, ...)
  76 {
  77     va_list args;
  78     FILE *f;
  79     char *logfilename;
  80
  81     if (is_logging_enabled ())
  82     {
  83         va_start (args, fmt);
  84         logfilename = g_strdup_printf ("%s/%s/log", home_dir, MC_USERCONF_DIR);
  85         if (logfilename != NULL)
  86         {
  87             f = fopen (logfilename, "a");
  88             if (f != NULL)
  89             {
  90                 (void) vfprintf (f, fmt, args);
  91                 (void) fclose (f);
  92             }
  93             g_free (logfilename);
  94             va_end (args);
  95         }
  96     }
  97 }
  98
  99 /* --------------------------------------------------------------------------------------------- */