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 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_interface.h>
35 #include <vlc_playlist.h>
36 #include <vlc_charset.h>
38 #include <errno.h> /* ENOMEM */
41 # define _IONBF 0x0004
49 #define LOG_DIR "Library/Logs/"
52 #define LOG_FILE_TEXT "vlc-log.txt"
53 #define LOG_FILE_HTML "vlc-log.html"
55 #define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );
57 #define TEXT_HEADER "-- logger module started --\n"
58 #define TEXT_FOOTER "-- logger module stopped --\n"
61 "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
62 " \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
65 " <title>vlc log</title>\n" \
66 " <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" \
68 " <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
70 " <b>-- logger module started --</b>\n"
72 " <b>-- logger module stopped --</b>\n" \
81 /*****************************************************************************
82 * intf_sys_t: description and status of log interface
83 *****************************************************************************/
89 time_t now; /* timestamp for rrd-log */
91 FILE * p_file; /* The log file */
92 msg_subscription_t *p_sub;
95 /*****************************************************************************
97 *****************************************************************************/
98 static int Open ( vlc_object_t * );
99 static void Close ( vlc_object_t * );
100 static void Run ( intf_thread_t * );
102 static void FlushQueue ( msg_subscription_t *, FILE *, int, int );
103 static void TextPrint ( const msg_item_t *, FILE * );
104 static void HtmlPrint ( const msg_item_t *, FILE * );
106 static void SyslogPrint ( const msg_item_t *);
109 static void DoRRD( intf_thread_t *p_intf );
111 /*****************************************************************************
113 *****************************************************************************/
114 static const char *const mode_list[] = { "text", "html"
119 static const char *const mode_list_text[] = { N_("Text"), "HTML"
125 #define LOGMODE_TEXT N_("Log format")
127 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
128 "\"text\" (default), \"html\", and \"syslog\" (special mode to send to " \
129 "syslog instead of file.")
131 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
132 "\"text\" (default) and \"html\".")
136 set_shortname( N_( "Logging" ) );
137 set_description( N_("File logging") );
139 set_category( CAT_ADVANCED );
140 set_subcategory( SUBCAT_ADVANCED_MISC );
142 add_file( "logfile", NULL, NULL,
143 N_("Log filename"), N_("Specify the log filename."), false );
145 add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
147 change_string_list( mode_list, mode_list_text, 0 );
149 add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
150 N_("Output data for RRDTool in this file." ), true );
152 set_capability( "interface", 0 );
153 set_callbacks( Open, Close );
156 /*****************************************************************************
157 * Open: initialize and create stuff
158 *****************************************************************************/
159 static int Open( vlc_object_t *p_this )
161 intf_thread_t *p_intf = (intf_thread_t *)p_this;
162 char *psz_mode, *psz_file, *psz_rrd_file;
165 msg_Info( p_intf, "using logger..." );
167 /* Allocate instance and initialize some members */
168 p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
169 if( p_intf->p_sys == NULL )
172 psz_mode = var_CreateGetString( p_intf, "logmode" );
175 if( !strcmp( psz_mode, "text" ) )
177 p_intf->p_sys->i_mode = MODE_TEXT;
179 else if( !strcmp( psz_mode, "html" ) )
181 p_intf->p_sys->i_mode = MODE_HTML;
184 else if( !strcmp( psz_mode, "syslog" ) )
186 p_intf->p_sys->i_mode = MODE_SYSLOG;
191 msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
192 p_intf->p_sys->i_mode = MODE_TEXT;
199 msg_Warn( p_intf, "no log mode specified, using `text'" );
200 p_intf->p_sys->i_mode = MODE_TEXT;
203 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
205 psz_file = config_GetPsz( p_intf, "logfile" );
209 if( asprintf( &psz_file, "%s/"LOG_DIR"/%s", config_GetHomeDir(),
210 (p_intf->p_sys->i_mode == MODE_HTML) ? LOG_FILE_HTML
211 : LOG_FILE_TEXT ) == -1 )
214 switch( p_intf->p_sys->i_mode )
217 psz_file = strdup( LOG_FILE_HTML );
221 psz_file = strdup( LOG_FILE_TEXT );
225 msg_Warn( p_intf, "no log filename provided, using `%s'",
229 /* Open the log file and remove any buffering for the stream */
230 msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
231 p_intf->p_sys->p_file = utf8_fopen( psz_file, "at" );
232 if( p_intf->p_sys->p_file == NULL )
234 msg_Err( p_intf, "error opening logfile `%s'", psz_file );
235 free( p_intf->p_sys );
239 setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
243 switch( p_intf->p_sys->i_mode )
246 LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
250 LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
257 p_intf->p_sys->p_file = NULL;
259 openlog( "vlc", LOG_PID|LOG_NDELAY, LOG_DAEMON );
263 p_intf->p_sys->last_update = 0;
264 p_intf->p_sys->p_rrd = NULL;
266 psz_rrd_file = config_GetPsz( p_intf, "rrd-file" );
267 if( psz_rrd_file && *psz_rrd_file )
269 p_intf->p_sys->p_rrd = utf8_fopen( psz_rrd_file, "w" );
271 free( psz_rrd_file );
273 p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
274 p_intf->pf_run = Run;
279 /*****************************************************************************
280 * Close: destroy interface stuff
281 *****************************************************************************/
282 static void Close( vlc_object_t *p_this )
284 intf_thread_t *p_intf = (intf_thread_t *)p_this;
286 /* Flush the queue and unsubscribe from the message queue */
287 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
288 p_intf->p_sys->i_mode,
289 var_CreateGetInteger( p_intf, "verbose" ) );
290 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
292 switch( p_intf->p_sys->i_mode )
295 LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
304 LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
308 /* Close the log file */
309 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
310 fclose( p_intf->p_sys->p_file );
312 /* Destroy structure */
313 free( p_intf->p_sys );
316 /*****************************************************************************
318 *****************************************************************************
319 * This part of the interface is in a separate thread so that we can call
320 * exec() from within it without annoying the rest of the program.
321 *****************************************************************************/
322 static void Run( intf_thread_t *p_intf )
324 while( vlc_object_alive (p_intf) )
326 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
327 p_intf->p_sys->i_mode,
328 var_CreateGetInteger( p_intf, "verbose" ) );
329 if( p_intf->p_sys->p_rrd )
332 msleep( INTF_IDLE_SLEEP );
336 /*****************************************************************************
337 * FlushQueue: flush the message queue into the log
338 *****************************************************************************/
339 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode,
344 vlc_mutex_lock( p_sub->p_lock );
345 i_stop = *p_sub->pi_stop;
346 vlc_mutex_unlock( p_sub->p_lock );
348 if( p_sub->i_start != i_stop )
350 /* Append all messages to log file */
351 for( i_start = p_sub->i_start;
353 i_start = (i_start+1) % VLC_MSG_QSIZE )
355 switch( p_sub->p_msg[i_start].i_type )
358 if( i_verbose < 0 ) continue;
361 if( i_verbose < 0 ) continue;
364 if( i_verbose < 1 ) continue;
367 if( i_verbose < 2 ) continue;
374 HtmlPrint( &p_sub->p_msg[i_start], p_file );
378 SyslogPrint( &p_sub->p_msg[i_start] );
383 TextPrint( &p_sub->p_msg[i_start], p_file );
388 vlc_mutex_lock( p_sub->p_lock );
389 p_sub->i_start = i_start;
390 vlc_mutex_unlock( p_sub->p_lock );
394 static const char *ppsz_type[4] = { ": ", " error: ",
395 " warning: ", " debug: " };
397 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
399 LOG_STRING( p_msg->psz_module, p_file );
400 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
401 LOG_STRING( p_msg->psz_msg, p_file );
402 LOG_STRING( "\n", p_file );
406 static void SyslogPrint( const msg_item_t *p_msg )
408 static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
409 int i_priority = i_prio[p_msg->i_type];
411 if( p_msg->psz_header )
412 syslog( i_priority, "%s%s %s: %s", p_msg->psz_header,
413 ppsz_type[p_msg->i_type],
414 p_msg->psz_module, p_msg->psz_msg );
416 syslog( i_priority, "%s%s: %s", p_msg->psz_module,
417 ppsz_type[p_msg->i_type], p_msg->psz_msg );
422 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
424 static const char *ppsz_color[4] = { "<span style=\"color: #ffffff\">",
425 "<span style=\"color: #ff6666\">",
426 "<span style=\"color: #ffff66\">",
427 "<span style=\"color: #aaaaaa\">" };
429 LOG_STRING( p_msg->psz_module, p_file );
430 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
431 LOG_STRING( ppsz_color[p_msg->i_type], p_file );
432 LOG_STRING( p_msg->psz_msg, p_file );
433 LOG_STRING( "</span>\n", p_file );
436 static void DoRRD( intf_thread_t *p_intf )
438 if( mdate() - p_intf->p_sys->last_update < 1000000 )
440 p_intf->p_sys->last_update = mdate();
442 if( p_intf->p_libvlc->p_stats )
444 time(&p_intf->p_sys->now);
445 lldiv_t din = lldiv( p_intf->p_libvlc->p_stats->f_input_bitrate * 1000000,
447 lldiv_t ddm = lldiv( p_intf->p_libvlc->p_stats->f_demux_bitrate * 1000000,
449 lldiv_t dout = lldiv( p_intf->p_libvlc->p_stats->f_output_bitrate * 1000000,
451 fprintf( p_intf->p_sys->p_rrd,
452 "%"PRIi64":%lld.%03u:%lld.%03u:%lld.%03u\n",
453 (uintmax_t)p_intf->p_sys->now,
454 din.quot, (unsigned int)din.rem,
455 ddm.quot, (unsigned int)ddm.rem,
456 dout.quot, (unsigned int)dout.rem );
457 fflush( p_intf->p_sys->p_rrd );