1 /*****************************************************************************
2 * logger.c : file logging plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2002 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
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
33 #include <vlc_interface.h>
34 #include <vlc_playlist.h>
35 #include <vlc_charset.h>
37 #include <errno.h> /* ENOMEM */
40 # define _IONBF 0x0004
48 #define LOG_DIR "Library/Logs/"
51 #define LOG_FILE_TEXT "vlc-log.txt"
52 #define LOG_FILE_HTML "vlc-log.html"
54 #define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );
56 #define TEXT_HEADER "-- logger module started --\n"
57 #define TEXT_FOOTER "-- logger module stopped --\n"
60 "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
61 " \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
64 " <title>vlc log</title>\n" \
65 " <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" \
67 " <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
69 " <b>-- logger module started --</b>\n"
71 " <b>-- logger module stopped --</b>\n" \
80 /*****************************************************************************
81 * intf_sys_t: description and status of log interface
82 *****************************************************************************/
89 FILE * p_file; /* The log file */
90 msg_subscription_t *p_sub;
93 /*****************************************************************************
95 *****************************************************************************/
96 static int Open ( vlc_object_t * );
97 static void Close ( vlc_object_t * );
98 static void Run ( intf_thread_t * );
100 static void FlushQueue ( msg_subscription_t *, FILE *, int, int );
101 static void TextPrint ( const msg_item_t *, FILE * );
102 static void HtmlPrint ( const msg_item_t *, FILE * );
104 static void SyslogPrint ( const msg_item_t *);
107 static void DoRRD( intf_thread_t *p_intf );
109 /*****************************************************************************
111 *****************************************************************************/
112 static const char *mode_list[] = { "text", "html"
117 static const char *mode_list_text[] = { N_("Text"), "HTML"
123 #define LOGMODE_TEXT N_("Log format")
125 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
126 "\"text\" (default), \"html\", and \"syslog\" (special mode to send to " \
127 "syslog instead of file.")
129 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
130 "\"text\" (default) and \"html\".")
134 set_shortname( _( "Logging" ) );
135 set_description( _("File logging") );
137 set_category( CAT_ADVANCED );
138 set_subcategory( SUBCAT_ADVANCED_MISC );
140 add_file( "logfile", NULL, NULL,
141 N_("Log filename"), N_("Specify the log filename."), false );
143 add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
145 change_string_list( mode_list, mode_list_text, 0 );
147 add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
148 N_("Output data for RRDTool in this file." ), true );
150 set_capability( "interface", 0 );
151 set_callbacks( Open, Close );
154 /*****************************************************************************
155 * Open: initialize and create stuff
156 *****************************************************************************/
157 static int Open( vlc_object_t *p_this )
159 intf_thread_t *p_intf = (intf_thread_t *)p_this;
160 char *psz_mode, *psz_file, *psz_rrd_file;
163 msg_Info( p_intf, "using logger..." );
165 /* Allocate instance and initialize some members */
166 p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
167 if( p_intf->p_sys == NULL )
169 msg_Err( p_intf, "out of memory" );
173 psz_mode = var_CreateGetString( p_intf, "logmode" );
176 if( !strcmp( psz_mode, "text" ) )
178 p_intf->p_sys->i_mode = MODE_TEXT;
180 else if( !strcmp( psz_mode, "html" ) )
182 p_intf->p_sys->i_mode = MODE_HTML;
185 else if( !strcmp( psz_mode, "syslog" ) )
187 p_intf->p_sys->i_mode = MODE_SYSLOG;
192 msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
193 p_intf->p_sys->i_mode = MODE_TEXT;
200 msg_Warn( p_intf, "no log mode specified, using `text'" );
201 p_intf->p_sys->i_mode = MODE_TEXT;
204 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
206 psz_file = config_GetPsz( p_intf, "logfile" );
210 char *psz_homedir = p_this->p_libvlc->psz_homedir;
212 if( !psz_homedir ) /* XXX: This should never happen */
214 msg_Err( p_this, "unable to find home directory" );
217 psz_file = (char *)malloc( sizeof("/" LOG_DIR "/" LOG_FILE_HTML) +
218 strlen(psz_homedir) );
221 switch( p_intf->p_sys->i_mode )
224 sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_HTML,
229 sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_TEXT,
235 switch( p_intf->p_sys->i_mode )
238 psz_file = strdup( LOG_FILE_HTML );
242 psz_file = strdup( LOG_FILE_TEXT );
246 msg_Warn( p_intf, "no log filename provided, using `%s'",
250 /* Open the log file and remove any buffering for the stream */
251 msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
252 p_intf->p_sys->p_file = utf8_fopen( psz_file, "at" );
253 if( p_intf->p_sys->p_file == NULL )
255 msg_Err( p_intf, "error opening logfile `%s'", psz_file );
256 free( p_intf->p_sys );
260 setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
264 switch( p_intf->p_sys->i_mode )
267 LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
271 LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
278 p_intf->p_sys->p_file = NULL;
280 openlog( "vlc", LOG_PID|LOG_NDELAY, LOG_DAEMON );
284 p_intf->p_sys->last_update = 0;
285 p_intf->p_sys->p_rrd = NULL;
287 psz_rrd_file = config_GetPsz( p_intf, "rrd-file" );
288 if( psz_rrd_file && *psz_rrd_file )
290 p_intf->p_sys->p_rrd = utf8_fopen( psz_rrd_file, "w" );
293 p_intf->p_sys->p_sub = msg_Subscribe( p_intf , MSG_QUEUE_NORMAL );
294 p_intf->pf_run = Run;
299 /*****************************************************************************
300 * Close: destroy interface stuff
301 *****************************************************************************/
302 static void Close( vlc_object_t *p_this )
304 intf_thread_t *p_intf = (intf_thread_t *)p_this;
306 /* Flush the queue and unsubscribe from the message queue */
307 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
308 p_intf->p_sys->i_mode,
309 var_CreateGetInteger( p_intf, "verbose" ) );
310 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
312 switch( p_intf->p_sys->i_mode )
315 LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
324 LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
328 /* Close the log file */
329 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
330 fclose( p_intf->p_sys->p_file );
332 /* Destroy structure */
333 free( p_intf->p_sys );
336 /*****************************************************************************
338 *****************************************************************************
339 * This part of the interface is in a separate thread so that we can call
340 * exec() from within it without annoying the rest of the program.
341 *****************************************************************************/
342 static void Run( intf_thread_t *p_intf )
344 while( !p_intf->b_die )
346 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
347 p_intf->p_sys->i_mode,
348 var_CreateGetInteger( p_intf, "verbose" ) );
349 if( p_intf->p_sys->p_rrd )
352 msleep( INTF_IDLE_SLEEP );
356 /*****************************************************************************
357 * FlushQueue: flush the message queue into the log
358 *****************************************************************************/
359 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode,
364 vlc_mutex_lock( p_sub->p_lock );
365 i_stop = *p_sub->pi_stop;
366 vlc_mutex_unlock( p_sub->p_lock );
368 if( p_sub->i_start != i_stop )
370 /* Append all messages to log file */
371 for( i_start = p_sub->i_start;
373 i_start = (i_start+1) % VLC_MSG_QSIZE )
375 switch( p_sub->p_msg[i_start].i_type )
378 if( i_verbose < 0 ) continue;
381 if( i_verbose < 0 ) continue;
384 if( i_verbose < 1 ) continue;
387 if( i_verbose < 2 ) continue;
394 HtmlPrint( &p_sub->p_msg[i_start], p_file );
398 SyslogPrint( &p_sub->p_msg[i_start] );
403 TextPrint( &p_sub->p_msg[i_start], p_file );
408 vlc_mutex_lock( p_sub->p_lock );
409 p_sub->i_start = i_start;
410 vlc_mutex_unlock( p_sub->p_lock );
414 static const char *ppsz_type[4] = { ": ", " error: ",
415 " warning: ", " debug: " };
417 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
419 LOG_STRING( p_msg->psz_module, p_file );
420 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
421 LOG_STRING( p_msg->psz_msg, p_file );
422 LOG_STRING( "\n", p_file );
426 static void SyslogPrint( const msg_item_t *p_msg )
428 static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
429 int i_priority = i_prio[p_msg->i_type];
431 if( p_msg->psz_header )
432 syslog( i_priority, "%s%s %s: %s", p_msg->psz_header,
433 ppsz_type[p_msg->i_type],
434 p_msg->psz_module, p_msg->psz_msg );
436 syslog( i_priority, "%s%s: %s", p_msg->psz_module,
437 ppsz_type[p_msg->i_type], p_msg->psz_msg );
442 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
444 static const char *ppsz_color[4] = { "<span style=\"color: #ffffff\">",
445 "<span style=\"color: #ff6666\">",
446 "<span style=\"color: #ffff66\">",
447 "<span style=\"color: #aaaaaa\">" };
449 LOG_STRING( p_msg->psz_module, p_file );
450 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
451 LOG_STRING( ppsz_color[p_msg->i_type], p_file );
452 LOG_STRING( p_msg->psz_msg, p_file );
453 LOG_STRING( "</span>\n", p_file );
456 static void DoRRD( intf_thread_t *p_intf )
458 if( mdate() - p_intf->p_sys->last_update < 1000000 )
460 p_intf->p_sys->last_update = mdate();
462 if( p_intf->p_libvlc->p_stats )
464 lldiv_t din = lldiv( p_intf->p_libvlc->p_stats->f_input_bitrate * 1000000,
466 lldiv_t ddm = lldiv( p_intf->p_libvlc->p_stats->f_demux_bitrate * 1000000,
468 lldiv_t dout = lldiv( p_intf->p_libvlc->p_stats->f_output_bitrate * 1000000,
470 fprintf( p_intf->p_sys->p_rrd,
471 "%"PRIi64":%lld.%03u:%lld.%03u:%lld.%03u\n",
472 p_intf->p_sys->last_update/1000000,
473 din.quot, (unsigned int)din.rem,
474 ddm.quot, (unsigned int)ddm.rem,
475 dout.quot, (unsigned int)dout.rem );
476 fflush( p_intf->p_sys->p_rrd );