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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*****************************************************************************
* file.c: file logger plugin
*****************************************************************************
* Copyright (C) 2002-2008 the VideoLAN team
* Copyright © 2007-2015 Rémi Denis-Courmont
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
#include <vlc_common.h>
#include <vlc_plugin.h>
#include <vlc_fs.h>
//#include <vlc_charset.h>
#include <stdarg.h>
#include <assert.h>
#include <errno.h>
static const char msg_type[4][9] = { "", " error", " warning", " debug" };
typedef struct
{
FILE *stream;
const char *footer;
int verbosity;
} vlc_logger_sys_t;
#define TEXT_FILENAME "vlc-log.txt"
#define TEXT_HEADER "\xEF\xBB\xBF" /* UTF-8 BOM */ \
"-- logger module started --\n"
#define TEXT_FOOTER "-- logger module stopped --\n"
static void LogText(void *opaque, int type, const vlc_log_t *meta,
const char *format, va_list ap)
{
vlc_logger_sys_t *sys = opaque;
FILE *stream = sys->stream;
if (sys->verbosity < type)
return;
flockfile(stream);
fprintf(stream, "%s%s: ", meta->psz_module, msg_type[type]);
vfprintf(stream, format, ap);
putc_unlocked('\n', stream);
funlockfile(stream);
}
#define HTML_FILENAME "vlc-log.html"
#define HTML_HEADER \
"<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
" \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
"<html>\n" \
" <head>\n" \
" <title>vlc log</title>\n" \
" <meta http-equiv=\"Content-Type\"" \
" content=\"text/html; charset=UTF-8\">\n" \
" </head>\n" \
" <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
" <pre>\n" \
" <strong>-- logger module started --</strong>\n"
#define HTML_FOOTER \
" <strong>-- logger module stopped --</strong>\n" \
" </pre>\n" \
" </body>\n" \
"</html>\n"
static void LogHtml(void *opaque, int type, const vlc_log_t *meta,
const char *format, va_list ap)
{
static const unsigned color[4] = {
0xffffff, 0xff6666, 0xffff66, 0xaaaaaa,
};
vlc_logger_sys_t *sys = opaque;
FILE *stream = sys->stream;
if (sys->verbosity < type)
return;
flockfile(stream);
fprintf(stream, "%s%s: <span style=\"color: #%06x\">",
meta->psz_module, msg_type[type], color[type]);
/* FIXME: encode special ASCII characters */
vfprintf(stream, format, ap);
fputs("</span>\n", stream);
funlockfile(stream);
}
static vlc_log_cb Open(vlc_object_t *obj, void **restrict sysp)
{
if (!var_InheritBool(obj, "file-logging"))
return NULL;
int verbosity = var_InheritInteger(obj, "log-verbose");
if (verbosity == -1)
verbosity = var_InheritInteger(obj, "verbose");
if (verbosity < 0)
return NULL; /* nothing to log */
verbosity += VLC_MSG_ERR;
vlc_logger_sys_t *sys = malloc(sizeof (*sys));
if (unlikely(sys == NULL))
return NULL;
const char *filename = TEXT_FILENAME;
const char *header = TEXT_HEADER;
vlc_log_cb cb = LogText;
sys->footer = TEXT_FOOTER;
sys->verbosity = verbosity;
char *mode = var_InheritString(obj, "logmode");
if (mode != NULL)
{
if (!strcmp(mode, "html"))
{
filename = HTML_FILENAME;
header = HTML_HEADER;
cb = LogHtml;
sys->footer = HTML_FOOTER;
}
else if (strcmp(mode, "text"))
msg_Warn(obj, "invalid log mode \"%s\"", mode);
free(mode);
}
char *path = var_InheritString(obj, "logfile");
#ifdef __APPLE__
if (path == NULL)
{
char *home = config_GetUserDir(VLC_HOME_DIR);
if (home != NULL)
{
if (asprintf(&path, "%s/Library/Logs/%s", home, path) == -1)
path = NULL;
free(home);
}
}
#endif
if (path != NULL)
filename = path;
/* Open the log file and remove any buffering for the stream */
msg_Dbg(obj, "opening logfile `%s'", filename);
sys->stream = vlc_fopen(filename, "at");
if (sys->stream == NULL)
{
msg_Err(obj, "error opening log file `%s': %s", filename,
vlc_strerror_c(errno) );
free(path);
free(sys);
return NULL;
}
free(path);
setvbuf(sys->stream, NULL, _IOLBF, 0);
fputs(header, sys->stream);
*sysp = sys;
return cb;
}
static void Close(void *opaque)
{
vlc_logger_sys_t *sys = opaque;
fputs(sys->footer, sys->stream);
fclose(sys->stream);
free(sys);
}
static const char *const mode_list[] = { "text", "html" };
static const char *const mode_list_text[] = { N_("Text"), N_("HTML") };
static const int verbosity_values[] = {
-1,
VLC_MSG_INFO,
VLC_MSG_ERR,
VLC_MSG_WARN,
VLC_MSG_DBG
};
static const char *const verbosity_text[] = { N_("Default"), N_("Info"), N_("Error"), N_("Warning"), N_("Debug") };
#define FILE_LOG_TEXT N_("Log to file")
#define FILE_LOG_LONGTEXT N_("Log all VLC messages to a text file.")
#define LOGFILE_NAME_TEXT N_("Log filename")
#define LOGFILE_NAME_LONGTEXT N_("Specify the log filename.")
#define LOGMODE_TEXT N_("Log format")
#define LOGMODE_LONGTEXT N_("Specify the logging format.")
#define LOGVERBOSE_TEXT N_("Verbosity")
#define LOGVERBOSE_LONGTEXT N_("Select the logging verbosity or " \
"default to use the same verbosity given by --verbose.")
vlc_module_begin()
set_shortname(N_("Logger"))
set_description(N_("File logger"))
set_category(CAT_ADVANCED)
set_subcategory(SUBCAT_ADVANCED_MISC)
set_capability("logger", 15)
set_callbacks(Open, Close)
add_bool("file-logging", false, FILE_LOG_TEXT, FILE_LOG_LONGTEXT, false)
add_savefile("logfile", NULL,
LOGFILE_NAME_TEXT, LOGFILE_NAME_LONGTEXT, false)
add_string("logmode", "text", LOGMODE_TEXT, LOGMODE_LONGTEXT, false)
change_string_list(mode_list, mode_list_text)
add_integer("log-verbose", -1, LOGVERBOSE_TEXT, LOGVERBOSE_LONGTEXT, false)
change_integer_list(verbosity_values, verbosity_text)
vlc_module_end ()
|
