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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
/*****************************************************************************
* logger.c : file logging plugin for vlc
*****************************************************************************
* Copyright (C) 2002-2008 the VideoLAN team
* $Id: e40dd968d53f9c93425976a187deae725d93a6d5 $
*
* 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.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <vlc_common.h>
#include <vlc_plugin.h>
#include <vlc_interface.h>
#include <vlc_fs.h>
#include <vlc_charset.h>
#include <stdarg.h>
#include <assert.h>
#include <errno.h>
#ifdef __ANDROID__
# include <android/log.h>
#endif
#define LOG_FILE_TEXT "vlc-log.txt"
#define LOG_FILE_HTML "vlc-log.html"
#define TEXT_HEADER "\xEF\xBB\xBF-- logger module started --\n"
#define TEXT_FOOTER "-- logger module stopped --\n"
#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"
#ifdef HAVE_SYSLOG_H
#include <syslog.h>
#endif
/*****************************************************************************
* intf_sys_t: description and status of log interface
*****************************************************************************/
struct intf_sys_t
{
FILE *p_file;
const char *footer;
char *ident;
};
/*****************************************************************************
* Local prototypes
*****************************************************************************/
static int Open ( vlc_object_t * );
static void Close ( vlc_object_t * );
static void TextPrint(void *, int, const vlc_log_t *, const char *, va_list);
static void HtmlPrint(void *, int, const vlc_log_t *, const char *, va_list);
#ifdef HAVE_SYSLOG_H
static void SyslogPrint(void *, int, const vlc_log_t *, const char *, va_list);
#endif
#ifdef __ANDROID__
static void AndroidPrint(void *, int, const vlc_log_t *, const char *, va_list);
#endif
/*****************************************************************************
* Module descriptor
*****************************************************************************/
static const char *const mode_list[] = { "text", "html"
#ifdef HAVE_SYSLOG_H
,"syslog"
#endif
#ifdef __ANDROID__
,"android"
#endif
};
static const char *const mode_list_text[] = { N_("Text"), "HTML"
#ifdef HAVE_SYSLOG_H
, "syslog"
#endif
#ifdef __ANDROID__
,"android"
#endif
};
#define LOGMODE_TEXT N_("Log format")
#define LOGMODE_LONGTEXT N_("Specify the logging format.")
#ifdef HAVE_SYSLOG_H
#define SYSLOG_IDENT_TEXT N_("Syslog ident")
#define SYSLOG_IDENT_LONGTEXT N_("Set the ident that VLC would use when " \
"logging to syslog.")
#define SYSLOG_FACILITY_TEXT N_("Syslog facility")
#define SYSLOG_FACILITY_LONGTEXT N_("Select the syslog facility where logs " \
"will be forwarded.")
/* First in list is the default facility used. */
#define DEFINE_SYSLOG_FACILITY \
DEF( "user", LOG_USER ), \
DEF( "daemon", LOG_DAEMON ), \
DEF( "local0", LOG_LOCAL0 ), \
DEF( "local1", LOG_LOCAL1 ), \
DEF( "local2", LOG_LOCAL2 ), \
DEF( "local3", LOG_LOCAL3 ), \
DEF( "local4", LOG_LOCAL4 ), \
DEF( "local5", LOG_LOCAL5 ), \
DEF( "local6", LOG_LOCAL6 ), \
DEF( "local7", LOG_LOCAL7 )
#define DEF( a, b ) a
static const char *const fac_name[] = { DEFINE_SYSLOG_FACILITY };
#undef DEF
#define DEF( a, b ) b
static const int fac_number[] = { DEFINE_SYSLOG_FACILITY };
#undef DEF
enum { fac_entries = sizeof(fac_name)/sizeof(fac_name[0]) };
#undef DEFINE_SYSLOG_FACILITY
#endif
#define LOGVERBOSE_TEXT N_("Verbosity")
#define LOGVERBOSE_LONGTEXT N_("Select the verbosity to use for log or -1 to " \
"use the same verbosity given by --verbose.")
vlc_module_begin ()
set_shortname( N_( "Logging" ) )
set_description( N_("File logging") )
set_category( CAT_ADVANCED )
set_subcategory( SUBCAT_ADVANCED_MISC )
add_savefile( "logfile", NULL,
N_("Log filename"), N_("Specify the log filename."), false )
add_string( "logmode", "text", LOGMODE_TEXT, LOGMODE_LONGTEXT,
false )
change_string_list( mode_list, mode_list_text )
#ifdef HAVE_SYSLOG_H
add_string( "syslog-ident", "vlc", SYSLOG_IDENT_TEXT,
SYSLOG_IDENT_LONGTEXT, true )
add_string( "syslog-facility", fac_name[0], SYSLOG_FACILITY_TEXT,
SYSLOG_FACILITY_LONGTEXT, true )
change_string_list( fac_name, fac_name )
#endif
add_integer( "log-verbose", -1, LOGVERBOSE_TEXT, LOGVERBOSE_LONGTEXT,
false )
add_obsolete_string( "rrd-file" )
set_capability( "interface", 0 )
set_callbacks( Open, Close )
vlc_module_end ()
/*****************************************************************************
* Open: initialize and create stuff
*****************************************************************************/
static int Open( vlc_object_t *p_this )
{
intf_thread_t *p_intf = (intf_thread_t *)p_this;
intf_sys_t *p_sys;
CONSOLE_INTRO_MSG;
msg_Info( p_intf, "using logger." );
/* Allocate instance and initialize some members */
p_sys = p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
if( p_sys == NULL )
return VLC_ENOMEM;
p_sys->p_file = NULL;
vlc_log_cb cb = TextPrint;
const char *filename = LOG_FILE_TEXT, *header = TEXT_HEADER;
p_sys->footer = TEXT_FOOTER;
char *mode = var_InheritString( p_intf, "logmode" );
if( mode != NULL )
{
if( !strcmp( mode, "html" ) )
{
p_sys->footer = HTML_FOOTER;
filename = LOG_FILE_HTML;
header = HTML_HEADER;
cb = HtmlPrint;
}
#ifdef HAVE_SYSLOG_H
else if( !strcmp( mode, "syslog" ) )
cb = SyslogPrint;
#endif
#ifdef __ANDROID__
else if( !strcmp( mode, "android" ) )
cb = AndroidPrint;
#endif
else if( strcmp( mode, "text" ) )
msg_Warn( p_intf, "invalid log mode `%s', using `text'", mode );
free( mode );
}
#ifdef HAVE_SYSLOG_H
if( cb == SyslogPrint )
{
int i_facility;
char *psz_facility = var_InheritString( p_intf, "syslog-facility" );
if( psz_facility )
{
bool b_valid = 0;
for( size_t i = 0; i < fac_entries; ++i )
{
if( !strcmp( psz_facility, fac_name[i] ) )
{
i_facility = fac_number[i];
b_valid = 1;
break;
}
}
if( !b_valid )
{
msg_Warn( p_intf, "invalid syslog facility `%s', using `%s'",
psz_facility, fac_name[0] );
i_facility = fac_number[0];
}
free( psz_facility );
}
else
{
msg_Warn( p_intf, "no syslog facility specified, using `%s'",
fac_name[0] );
i_facility = fac_number[0];
}
char *psz_syslog_ident = var_InheritString( p_intf, "syslog-ident" );
if (unlikely(psz_syslog_ident == NULL))
{
free( p_sys );
return VLC_ENOMEM;
}
p_sys->ident = psz_syslog_ident;
openlog( p_sys->ident, LOG_PID|LOG_NDELAY, i_facility );
p_sys->p_file = NULL;
}
else
#endif
#ifdef __ANDROID__
if( cb == AndroidPrint )
{
/* nothing to do */
}
else
#endif
{
char *psz_file = var_InheritString( p_intf, "logfile" );
if( !psz_file )
{
#ifdef __APPLE__
# define LOG_DIR "Library/Logs"
char *home = config_GetUserDir(VLC_HOME_DIR);
if( home == NULL
|| asprintf( &psz_file, "%s/"LOG_DIR"/%s", home,
filename ) == -1 )
psz_file = NULL;
free(home);
filename = psz_file;
#endif
msg_Warn( p_intf, "no log filename provided, using `%s'",
filename );
}
else
filename = psz_file;
/* Open the log file and remove any buffering for the stream */
msg_Dbg( p_intf, "opening logfile `%s'", filename );
p_sys->p_file = vlc_fopen( filename, "at" );
if( p_sys->p_file == NULL )
{
msg_Err( p_intf, "error opening logfile `%s': %s", filename,
vlc_strerror_c(errno) );
free( psz_file );
free( p_sys );
return VLC_EGENERIC;
}
free( psz_file );
setvbuf( p_sys->p_file, NULL, _IONBF, 0 );
fputs( header, p_sys->p_file );
}
vlc_LogSet( p_intf->p_libvlc, cb, p_intf );
return VLC_SUCCESS;
}
/*****************************************************************************
* Close: destroy interface stuff
*****************************************************************************/
static void Close( vlc_object_t *p_this )
{
intf_thread_t *p_intf = (intf_thread_t *)p_this;
intf_sys_t *p_sys = p_intf->p_sys;
/* Flush the queue and unsubscribe from the message queue */
vlc_LogSet( p_intf->p_libvlc, NULL, NULL );
/* Close the log file */
#ifdef HAVE_SYSLOG_H
if( p_sys->p_file == NULL )
{
closelog();
free( p_sys->ident );
}
else
#endif
if( p_sys->p_file )
{
fputs( p_sys->footer, p_sys->p_file );
fclose( p_sys->p_file );
}
/* Destroy structure */
free( p_sys );
}
static bool IgnoreMessage( intf_thread_t *p_intf, int type )
{
/* TODO: cache value... */
int verbosity = var_InheritInteger( p_intf, "log-verbose" );
if (verbosity == -1)
verbosity = var_InheritInteger( p_intf, "verbose" );
return verbosity < 0 || verbosity < (type - VLC_MSG_ERR);
}
/*
* Logging callbacks
*/
static const char ppsz_type[4][9] = {
"",
" error",
" warning",
" debug",
};
#ifdef __ANDROID__
static const android_LogPriority prioritytype[4] = {
ANDROID_LOG_INFO,
ANDROID_LOG_ERROR,
ANDROID_LOG_WARN,
ANDROID_LOG_DEBUG
};
static void AndroidPrint( void *opaque, int type, const vlc_log_t *item,
const char *fmt, va_list ap )
{
(void)item;
intf_thread_t *p_intf = opaque;
if( IgnoreMessage( p_intf, type ) )
return;
int canc = vlc_savecancel();
__android_log_vprint(prioritytype[type], "VLC", fmt, ap);
vlc_restorecancel( canc );
}
#endif
static void TextPrint( void *opaque, int type, const vlc_log_t *item,
const char *fmt, va_list ap )
{
intf_thread_t *p_intf = opaque;
FILE *stream = p_intf->p_sys->p_file;
if( IgnoreMessage( p_intf, type ) )
return;
int canc = vlc_savecancel();
flockfile( stream );
fprintf( stream, "%s%s: ", item->psz_module, ppsz_type[type] );
vfprintf( stream, fmt, ap );
putc_unlocked( '\n', stream );
funlockfile( stream );
vlc_restorecancel( canc );
}
#ifdef HAVE_SYSLOG_H
static void SyslogPrint( void *opaque, int type, const vlc_log_t *item,
const char *fmt, va_list ap )
{
static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
intf_thread_t *p_intf = opaque;
char *str;
int i_priority = i_prio[type];
if( IgnoreMessage( p_intf, type )
|| unlikely(vasprintf( &str, fmt, ap ) == -1) )
return;
int canc = vlc_savecancel();
if( item->psz_header != NULL )
syslog( i_priority, "[%s] %s%s: %s", item->psz_header,
item->psz_module, ppsz_type[type], str );
else
syslog( i_priority, "%s%s: %s",
item->psz_module, ppsz_type[type], str );
vlc_restorecancel( canc );
free( str );
}
#endif
static void HtmlPrint( void *opaque, int type, const vlc_log_t *item,
const char *fmt, va_list ap )
{
static const unsigned color[4] = {
0xffffff, 0xff6666, 0xffff66, 0xaaaaaa,
};
intf_thread_t *p_intf = opaque;
FILE *stream = p_intf->p_sys->p_file;
if( IgnoreMessage( p_intf, type ) )
return;
int canc = vlc_savecancel();
flockfile( stream );
fprintf( stream, "%s%s: <span style=\"color: #%06x\">",
item->psz_module, ppsz_type[type], color[type] );
/* FIXME: encode special ASCII characters */
vfprintf( stream, fmt, ap );
fputs( "</span>\n", stream );
funlockfile( stream );
vlc_restorecancel( canc );
}
|
