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 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
30 #include <errno.h> /* ENOMEM */
34 # define _IONBF 0x0004
38 #include <vlc_interface.h>
39 #include <vlc_playlist.h>
40 #include <vlc_charset.h>
47 #define LOG_DIR "Library/Logs/"
50 #define LOG_FILE_TEXT "vlc-log.txt"
51 #define LOG_FILE_HTML "vlc-log.html"
53 #define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );
55 #define TEXT_HEADER "-- logger module started --\n"
56 #define TEXT_FOOTER "-- logger module stopped --\n"
61 " <title>vlc log</title>\n" \
63 " <body bgcolor=\"#000000\" text=\"#aaaaaa\">\n" \
65 " <b>-- logger module started --</b>\n"
67 " <b>-- logger module stopped --</b>\n" \
76 /*****************************************************************************
77 * intf_sys_t: description and status of log interface
78 *****************************************************************************/
85 FILE * p_file; /* The log file */
86 msg_subscription_t *p_sub;
89 /*****************************************************************************
91 *****************************************************************************/
92 static int Open ( vlc_object_t * );
93 static void Close ( vlc_object_t * );
94 static void Run ( intf_thread_t * );
96 static void FlushQueue ( msg_subscription_t *, FILE *, int );
97 static void TextPrint ( const msg_item_t *, FILE * );
98 static void HtmlPrint ( const msg_item_t *, FILE * );
100 static void SyslogPrint ( const msg_item_t *);
103 static void DoRRD( intf_thread_t *p_intf );
105 /*****************************************************************************
107 *****************************************************************************/
108 static char *mode_list[] = { "text", "html"
113 static char *mode_list_text[] = { N_("Text"), "HTML"
119 #define LOGMODE_TEXT N_("Log format")
121 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
122 "\"text\" (default), \"html\", and \"syslog\" (special mode to send to " \
123 "syslog instead of file.")
125 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
126 "\"text\" (default) and \"html\".")
130 set_shortname( _( "Logging" ) );
131 set_description( _("File logging") );
133 set_category( CAT_ADVANCED );
134 set_subcategory( SUBCAT_ADVANCED_MISC );
136 add_file( "logfile", NULL, NULL,
137 N_("Log filename"), N_("Specify the log filename."), VLC_FALSE );
138 add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
140 change_string_list( mode_list, mode_list_text, 0 );
142 add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
143 N_("Output data for RRDTool in this file." ), VLC_TRUE );
145 set_capability( "interface", 0 );
146 set_callbacks( Open, Close );
149 /*****************************************************************************
150 * Open: initialize and create stuff
151 *****************************************************************************/
152 static int Open( vlc_object_t *p_this )
154 intf_thread_t *p_intf = (intf_thread_t *)p_this;
155 char *psz_mode, *psz_file, *psz_rrd_file;
158 msg_Info( p_intf, "using logger..." );
160 /* Allocate instance and initialize some members */
161 p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
162 if( p_intf->p_sys == NULL )
164 msg_Err( p_intf, "out of memory" );
168 psz_mode = var_CreateGetString( p_intf, "logmode" );
171 if( !strcmp( psz_mode, "text" ) )
173 p_intf->p_sys->i_mode = MODE_TEXT;
175 else if( !strcmp( psz_mode, "html" ) )
177 p_intf->p_sys->i_mode = MODE_HTML;
180 else if( !strcmp( psz_mode, "syslog" ) )
182 p_intf->p_sys->i_mode = MODE_SYSLOG;
187 msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
188 p_intf->p_sys->i_mode = MODE_TEXT;
195 msg_Warn( p_intf, "no log mode specified, using `text'" );
196 p_intf->p_sys->i_mode = MODE_TEXT;
199 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
201 psz_file = config_GetPsz( p_intf, "logfile" );
205 char *psz_homedir = p_this->p_libvlc->psz_homedir;
209 msg_Err( p_this, "unable to find home directory" );
212 psz_file = (char *)malloc( sizeof("/" LOG_DIR "/" LOG_FILE_HTML) +
213 strlen(psz_homedir) );
216 switch( p_intf->p_sys->i_mode )
219 sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_HTML,
224 sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_TEXT,
230 switch( p_intf->p_sys->i_mode )
233 psz_file = strdup( LOG_FILE_HTML );
237 psz_file = strdup( LOG_FILE_TEXT );
241 msg_Warn( p_intf, "no log filename provided, using `%s'",
245 /* Open the log file and remove any buffering for the stream */
246 msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
247 p_intf->p_sys->p_file = utf8_fopen( psz_file, "at" );
248 if( p_intf->p_sys->p_file == NULL )
250 msg_Err( p_intf, "error opening logfile `%s'", psz_file );
251 free( p_intf->p_sys );
255 setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
259 switch( p_intf->p_sys->i_mode )
262 LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
266 LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
273 p_intf->p_sys->p_file = NULL;
275 openlog( "VLC", 0, LOG_DAEMON );
279 p_intf->p_sys->last_update = 0;
280 p_intf->p_sys->p_rrd = NULL;
282 psz_rrd_file = config_GetPsz( p_intf, "rrd-file" );
283 if( psz_rrd_file && *psz_rrd_file )
285 p_intf->p_sys->p_rrd = utf8_fopen( psz_rrd_file, "w" );
288 p_intf->p_sys->p_sub = msg_Subscribe( p_intf , MSG_QUEUE_NORMAL );
289 p_intf->pf_run = Run;
294 /*****************************************************************************
295 * Close: destroy interface stuff
296 *****************************************************************************/
297 static void Close( vlc_object_t *p_this )
299 intf_thread_t *p_intf = (intf_thread_t *)p_this;
301 /* Flush the queue and unsubscribe from the message queue */
302 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
303 p_intf->p_sys->i_mode );
304 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
306 switch( p_intf->p_sys->i_mode )
309 LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
318 LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
322 /* Close the log file */
323 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
324 fclose( p_intf->p_sys->p_file );
326 /* Destroy structure */
327 free( p_intf->p_sys );
330 /*****************************************************************************
332 *****************************************************************************
333 * This part of the interface is in a separate thread so that we can call
334 * exec() from within it without annoying the rest of the program.
335 *****************************************************************************/
336 static void Run( intf_thread_t *p_intf )
338 while( !p_intf->b_die )
340 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
341 p_intf->p_sys->i_mode );
343 if( p_intf->p_sys->p_rrd )
346 msleep( INTF_IDLE_SLEEP );
350 /*****************************************************************************
351 * FlushQueue: flush the message queue into the log
352 *****************************************************************************/
353 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode )
357 vlc_mutex_lock( p_sub->p_lock );
358 i_stop = *p_sub->pi_stop;
359 vlc_mutex_unlock( p_sub->p_lock );
361 if( p_sub->i_start != i_stop )
363 /* Append all messages to log file */
364 for( i_start = p_sub->i_start;
366 i_start = (i_start+1) % VLC_MSG_QSIZE )
371 HtmlPrint( &p_sub->p_msg[i_start], p_file );
375 SyslogPrint( &p_sub->p_msg[i_start] );
380 TextPrint( &p_sub->p_msg[i_start], p_file );
385 vlc_mutex_lock( p_sub->p_lock );
386 p_sub->i_start = i_start;
387 vlc_mutex_unlock( p_sub->p_lock );
391 static const char *ppsz_type[4] = { ": ", " error: ",
392 " warning: ", " debug: " };
394 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
396 LOG_STRING( p_msg->psz_module, p_file );
397 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
398 LOG_STRING( p_msg->psz_msg, p_file );
399 LOG_STRING( "\n", p_file );
403 static void SyslogPrint( const msg_item_t *p_msg )
405 int i_priority = LOG_INFO;
407 if( p_msg->i_type == 0 ) i_priority = LOG_INFO;
408 if( p_msg->i_type == 1 ) i_priority = LOG_ERR;
409 if( p_msg->i_type == 2 ) i_priority = LOG_WARNING;
410 if( p_msg->i_type == 3 ) i_priority = LOG_DEBUG;
412 if( p_msg->psz_header )
413 syslog( i_priority, "%s %s: %s", p_msg->psz_header,
414 p_msg->psz_module, p_msg->psz_msg );
416 syslog( i_priority, "%s: %s", p_msg->psz_module, p_msg->psz_msg );
421 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
423 static const char *ppsz_color[4] = { "<font color=\"#ffffff\">",
424 "<font color=\"#ff6666\">",
425 "<font color=\"#ffff66\">",
426 "<font color=\"#aaaaaa\">" };
428 LOG_STRING( p_msg->psz_module, p_file );
429 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
430 LOG_STRING( ppsz_color[p_msg->i_type], p_file );
431 LOG_STRING( p_msg->psz_msg, p_file );
432 LOG_STRING( "</font>\n", p_file );
435 static void DoRRD( intf_thread_t *p_intf )
437 playlist_t *p_playlist;
438 if( mdate() - p_intf->p_sys->last_update < 1000000 )
440 p_intf->p_sys->last_update = mdate();
442 p_playlist = (playlist_t *)vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
444 if( p_playlist && p_playlist->p_stats )
446 lldiv_t din = lldiv( p_playlist->p_stats->f_input_bitrate * 1000000,
448 lldiv_t ddm = lldiv( p_playlist->p_stats->f_demux_bitrate * 1000000,
450 lldiv_t dout = lldiv( p_playlist->p_stats->f_output_bitrate * 1000000,
452 fprintf( p_intf->p_sys->p_rrd,
453 I64Fi":%lld.%03u:%lld.%03u:%lld.%03u\n",
454 p_intf->p_sys->last_update/1000000,
455 din.quot, (unsigned int)din.rem,
456 ddm.quot, (unsigned int)ddm.rem,
457 dout.quot, (unsigned int)dout.rem );
458 fflush( p_intf->p_sys->p_rrd );
459 vlc_object_release( p_playlist );