1 /*****************************************************************************
2 * logger.c : file logging plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2002-2008 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_interface.h>
36 #include <vlc_charset.h>
42 # include <android/log.h>
45 #define LOG_FILE_TEXT "vlc-log.txt"
46 #define LOG_FILE_HTML "vlc-log.html"
48 #define TEXT_HEADER "\xEF\xBB\xBF-- logger module started --\n"
49 #define TEXT_FOOTER "-- logger module stopped --\n"
52 "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
53 " \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
56 " <title>vlc log</title>\n" \
57 " <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" \
59 " <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
61 " <strong>-- logger module started --</strong>\n"
63 " <strong>-- logger module stopped --</strong>\n" \
72 /*****************************************************************************
73 * intf_sys_t: description and status of log interface
74 *****************************************************************************/
77 msg_subscription_t sub;
82 /*****************************************************************************
84 *****************************************************************************/
85 static int Open ( vlc_object_t * );
86 static void Close ( vlc_object_t * );
88 static void TextPrint(void *, int, const msg_item_t *, const char *, va_list);
89 static void HtmlPrint(void *, int, const msg_item_t *, const char *, va_list);
91 static void SyslogPrint(void *, int, const msg_item_t *, const char *,
95 static void AndroidPrint(void *, int, const msg_item_t *, const char *, va_list);
98 /*****************************************************************************
100 *****************************************************************************/
101 static const char *const mode_list[] = { "text", "html"
109 static const char *const mode_list_text[] = { N_("Text"), "HTML"
118 #define LOGMODE_TEXT N_("Log format")
119 #define LOGMODE_LONGTEXT N_("Specify the logging format.")
122 #define SYSLOG_FACILITY_TEXT N_("Syslog facility")
123 #define SYSLOG_FACILITY_LONGTEXT N_("Select the syslog facility where logs " \
124 "will be forwarded.")
126 /* First in list is the default facility used. */
127 #define DEFINE_SYSLOG_FACILITY \
128 DEF( "user", LOG_USER ), \
129 DEF( "daemon", LOG_DAEMON ), \
130 DEF( "local0", LOG_LOCAL0 ), \
131 DEF( "local1", LOG_LOCAL1 ), \
132 DEF( "local2", LOG_LOCAL2 ), \
133 DEF( "local3", LOG_LOCAL3 ), \
134 DEF( "local4", LOG_LOCAL4 ), \
135 DEF( "local5", LOG_LOCAL5 ), \
136 DEF( "local6", LOG_LOCAL6 ), \
137 DEF( "local7", LOG_LOCAL7 )
139 #define DEF( a, b ) a
140 static const char *const fac_name[] = { DEFINE_SYSLOG_FACILITY };
142 #define DEF( a, b ) b
143 static const int fac_number[] = { DEFINE_SYSLOG_FACILITY };
145 enum { fac_entries = sizeof(fac_name)/sizeof(fac_name[0]) };
146 #undef DEFINE_SYSLOG_FACILITY
150 #define LOGVERBOSE_TEXT N_("Verbosity")
151 #define LOGVERBOSE_LONGTEXT N_("Select the verbosity to use for log or -1 to " \
152 "use the same verbosity given by --verbose.")
155 set_shortname( N_( "Logging" ) )
156 set_description( N_("File logging") )
158 set_category( CAT_ADVANCED )
159 set_subcategory( SUBCAT_ADVANCED_MISC )
161 add_savefile( "logfile", NULL,
162 N_("Log filename"), N_("Specify the log filename."), false )
163 add_string( "logmode", "text", LOGMODE_TEXT, LOGMODE_LONGTEXT,
165 change_string_list( mode_list, mode_list_text )
167 add_string( "syslog-facility", fac_name[0], SYSLOG_FACILITY_TEXT,
168 SYSLOG_FACILITY_LONGTEXT, true )
169 change_string_list( fac_name, fac_name )
171 add_integer( "log-verbose", -1, LOGVERBOSE_TEXT, LOGVERBOSE_LONGTEXT,
174 add_obsolete_string( "rrd-file" )
176 set_capability( "interface", 0 )
177 set_callbacks( Open, Close )
180 /*****************************************************************************
181 * Open: initialize and create stuff
182 *****************************************************************************/
183 static int Open( vlc_object_t *p_this )
185 intf_thread_t *p_intf = (intf_thread_t *)p_this;
189 msg_Info( p_intf, "using logger." );
191 /* Allocate instance and initialize some members */
192 p_sys = p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
196 p_sys->p_file = NULL;
197 msg_callback_t cb = TextPrint;
198 const char *filename = LOG_FILE_TEXT, *header = TEXT_HEADER;
199 p_sys->footer = TEXT_FOOTER;
201 char *mode = var_InheritString( p_intf, "logmode" );
204 if( !strcmp( mode, "html" ) )
206 p_sys->footer = HTML_FOOTER;
207 header = HTML_HEADER;
211 else if( !strcmp( mode, "syslog" ) )
215 else if( !strcmp( mode, "android" ) )
218 else if( strcmp( mode, "text" ) )
219 msg_Warn( p_intf, "invalid log mode `%s', using `text'", mode );
224 if( cb == SyslogPrint )
227 char *psz_facility = var_InheritString( p_intf, "syslog-facility" );
231 for( size_t i = 0; i < fac_entries; ++i )
233 if( !strcmp( psz_facility, fac_name[i] ) )
235 i_facility = fac_number[i];
242 msg_Warn( p_intf, "invalid syslog facility `%s', using `%s'",
243 psz_facility, fac_name[0] );
244 i_facility = fac_number[0];
246 free( psz_facility );
250 msg_Warn( p_intf, "no syslog facility specified, using `%s'",
252 i_facility = fac_number[0];
255 openlog( "vlc", LOG_PID|LOG_NDELAY, i_facility );
256 p_sys->p_file = NULL;
261 if( cb == AndroidPrint )
268 char *psz_file = var_InheritString( p_intf, "logfile" );
272 # define LOG_DIR "Library/Logs"
273 char *home = config_GetUserDir(VLC_HOME_DIR);
275 || asprintf( &psz_file, "%s/"LOG_DIR"/%s", home,
281 msg_Warn( p_intf, "no log filename provided, using `%s'",
287 /* Open the log file and remove any buffering for the stream */
288 msg_Dbg( p_intf, "opening logfile `%s'", filename );
289 p_sys->p_file = vlc_fopen( filename, "at" );
291 if( p_sys->p_file == NULL )
293 msg_Err( p_intf, "error opening logfile `%s': %m", filename );
297 setvbuf( p_sys->p_file, NULL, _IONBF, 0 );
298 fputs( header, p_sys->p_file );
301 vlc_Subscribe( &p_sys->sub, cb, p_intf );
305 /*****************************************************************************
306 * Close: destroy interface stuff
307 *****************************************************************************/
308 static void Close( vlc_object_t *p_this )
310 intf_thread_t *p_intf = (intf_thread_t *)p_this;
311 intf_sys_t *p_sys = p_intf->p_sys;
313 /* Flush the queue and unsubscribe from the message queue */
314 vlc_Unsubscribe( &p_sys->sub );
316 /* Close the log file */
318 if( p_sys->p_file == NULL )
324 fputs( p_sys->footer, p_sys->p_file );
325 fclose( p_sys->p_file );
328 /* Destroy structure */
332 static bool IgnoreMessage( intf_thread_t *p_intf, int type )
334 /* TODO: cache value... */
335 int verbosity = var_InheritInteger( p_intf, "log-verbose" );
337 verbosity = var_InheritInteger( p_intf, "verbose" );
339 return verbosity < 0 || verbosity < (type - VLC_MSG_ERR);
346 static const char ppsz_type[4][9] = {
354 static const android_LogPriority prioritytype[4] = {
361 static void AndroidPrint( void *opaque, int type, const msg_item_t *item,
362 const char *fmt, va_list ap )
365 intf_thread_t *p_intf = opaque;
367 if( IgnoreMessage( p_intf, type ) )
370 int canc = vlc_savecancel();
371 __android_log_vprint(prioritytype[type], "VLC", fmt, ap);
372 vlc_restorecancel( canc );
376 static void TextPrint( void *opaque, int type, const msg_item_t *item,
377 const char *fmt, va_list ap )
379 intf_thread_t *p_intf = opaque;
380 FILE *stream = p_intf->p_sys->p_file;
382 if( IgnoreMessage( p_intf, type ) )
385 int canc = vlc_savecancel();
387 fprintf( stream, "%s%s: ", item->psz_module, ppsz_type[type] );
388 vfprintf( stream, fmt, ap );
389 putc_unlocked( '\n', stream );
390 funlockfile( stream );
391 vlc_restorecancel( canc );
395 static void SyslogPrint( void *opaque, int type, const msg_item_t *item,
396 const char *fmt, va_list ap )
398 static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
400 intf_thread_t *p_intf = opaque;
402 int i_priority = i_prio[type];
404 if( IgnoreMessage( p_intf, type )
405 || unlikely(vasprintf( &str, fmt, ap ) == -1) )
408 int canc = vlc_savecancel();
409 if( item->psz_header != NULL )
410 syslog( i_priority, "[%s] %s%s: %s", item->psz_header,
411 item->psz_module, ppsz_type[type], str );
413 syslog( i_priority, "%s%s: %s",
414 item->psz_module, ppsz_type[type], str );
415 vlc_restorecancel( canc );
420 static void HtmlPrint( void *opaque, int type, const msg_item_t *item,
421 const char *fmt, va_list ap )
423 static const unsigned color[4] = {
424 0xffffff, 0xff6666, 0xffff66, 0xaaaaaa,
427 intf_thread_t *p_intf = opaque;
428 FILE *stream = p_intf->p_sys->p_file;
430 if( IgnoreMessage( p_intf, type ) )
433 int canc = vlc_savecancel();
435 fprintf( stream, "%s%s: <span style=\"color: #%06x\">",
436 item->psz_module, ppsz_type[type], color[type] );
437 /* FIXME: encode special ASCII characters */
438 vfprintf( stream, fmt, ap );
439 fputs( "</span>\n", stream );
440 funlockfile( stream );
441 vlc_restorecancel( canc );