1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*
Provides a log file to ease tracing the program.
Copyright (C) 2006-2024
Free Software Foundation, Inc.
Written by:
Roland Illig <roland.illig@gmx.de>, 2006
Slava Zanko <slavazanko@gmail.com>, 2009, 2011
This file is part of the Midnight Commander.
The Midnight Commander 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.
The Midnight Commander 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/>.
*/
/** \file logging.c
* \brief Source: provides a log file to ease tracing the program
*/
#include <config.h>
#include <stdarg.h>
#include <stdio.h>
#include "lib/global.h"
#include "lib/mcconfig.h"
#include "lib/fileloc.h"
#include "logging.h"
/*** global variables ****************************************************************************/
/*** file scope macro definitions ****************************************************************/
#define CONFIG_GROUP_NAME "Development"
#define CONFIG_KEY_NAME "logging"
#define CONFIG_KEY_NAME_FILE "logfile"
/*** file scope type declarations ****************************************************************/
/*** forward declarations (file scope functions) *************************************************/
/*** file scope variables ************************************************************************/
static gboolean logging_initialized = FALSE;
static gboolean logging_enabled = FALSE;
/* --------------------------------------------------------------------------------------------- */
/*** file scope functions ************************************************************************/
/* --------------------------------------------------------------------------------------------- */
static gboolean
is_logging_enabled_from_env (void)
{
const char *env_is_enabled;
env_is_enabled = g_getenv ("MC_LOG_ENABLE");
if (env_is_enabled == NULL)
return FALSE;
logging_enabled = (*env_is_enabled == '1' || g_ascii_strcasecmp (env_is_enabled, "true") == 0);
logging_initialized = TRUE;
return TRUE;
}
/* --------------------------------------------------------------------------------------------- */
static gboolean
is_logging_enabled (void)
{
if (logging_initialized)
return logging_enabled;
if (is_logging_enabled_from_env ())
return logging_enabled;
logging_enabled =
mc_config_get_bool (mc_global.main_config, CONFIG_GROUP_NAME, CONFIG_KEY_NAME, FALSE);
logging_initialized = TRUE;
return logging_enabled;
}
/* --------------------------------------------------------------------------------------------- */
static char *
get_log_filename (void)
{
const char *env_filename;
env_filename = g_getenv ("MC_LOG_FILE");
if (env_filename != NULL)
return g_strdup (env_filename);
if (mc_config_has_param (mc_global.main_config, CONFIG_GROUP_NAME, CONFIG_KEY_NAME_FILE))
return mc_config_get_string (mc_global.main_config, CONFIG_GROUP_NAME, CONFIG_KEY_NAME_FILE,
NULL);
return mc_config_get_full_path ("mc.log");
}
/* --------------------------------------------------------------------------------------------- */
static void
G_GNUC_PRINTF (1, 0)
mc_va_log (const char *fmt, va_list args)
{
char *logfilename;
logfilename = get_log_filename ();
if (logfilename != NULL)
{
FILE *f;
f = fopen (logfilename, "a");
if (f != NULL)
{
(void) vfprintf (f, fmt, args);
(void) fclose (f);
}
g_free (logfilename);
}
}
/* --------------------------------------------------------------------------------------------- */
/*** public functions ****************************************************************************/
/* --------------------------------------------------------------------------------------------- */
void
mc_log (const char *fmt, ...)
{
va_list args;
if (!is_logging_enabled ())
return;
va_start (args, fmt);
mc_va_log (fmt, args);
va_end (args);
}
/* --------------------------------------------------------------------------------------------- */
void
mc_always_log (const char *fmt, ...)
{
va_list args;
va_start (args, fmt);
mc_va_log (fmt, args);
va_end (args);
}
/* --------------------------------------------------------------------------------------------- */
|
