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
46 #define LOG_DIR "Library/Logs/"
49 #define LOG_FILE_TEXT "vlc-log.txt"
50 #define LOG_FILE_HTML "vlc-log.html"
52 #define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );
54 #define TEXT_HEADER "-- logger module started --\n"
55 #define TEXT_FOOTER "-- logger module stopped --\n"
60 " <title>vlc log</title>\n" \
62 " <body bgcolor=\"#000000\" text=\"#aaaaaa\">\n" \
64 " <b>-- logger module started --</b>\n"
66 " <b>-- logger module stopped --</b>\n" \
75 /*****************************************************************************
76 * intf_sys_t: description and status of log interface
77 *****************************************************************************/
84 FILE * p_file; /* The log file */
85 msg_subscription_t *p_sub;
88 /*****************************************************************************
90 *****************************************************************************/
91 static int Open ( vlc_object_t * );
92 static void Close ( vlc_object_t * );
93 static void Run ( intf_thread_t * );
95 static void FlushQueue ( msg_subscription_t *, FILE *, int );
96 static void TextPrint ( const msg_item_t *, FILE * );
97 static void HtmlPrint ( const msg_item_t *, FILE * );
99 static void SyslogPrint ( const msg_item_t *);
102 static void DoRRD( intf_thread_t *p_intf );
104 /*****************************************************************************
106 *****************************************************************************/
107 static char *mode_list[] = { "text", "html"
112 static char *mode_list_text[] = { N_("Text"), "HTML"
118 #define LOGMODE_TEXT N_("Log format")
120 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
121 "\"text\" (default), \"html\", and \"syslog\" (special mode to send to " \
122 "syslog instead of file.")
124 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
125 "\"text\" (default) and \"html\".")
129 set_shortname( N_( "Logging" ) );
130 set_description( _("File logging") );
132 set_category( CAT_ADVANCED );
133 set_subcategory( SUBCAT_ADVANCED_MISC );
135 add_file( "logfile", NULL, NULL,
136 N_("Log filename"), N_("Specify the log filename."), VLC_FALSE );
137 add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
139 change_string_list( mode_list, mode_list_text, 0 );
141 add_string( "rrd-file", NULL, NULL, N_("RRD output file") ,
142 N_("Output data for RRDTool in this file" ), VLC_TRUE );
144 set_capability( "interface", 0 );
145 set_callbacks( Open, Close );
148 /*****************************************************************************
149 * Open: initialize and create stuff
150 *****************************************************************************/
151 static int Open( vlc_object_t *p_this )
153 intf_thread_t *p_intf = (intf_thread_t *)p_this;
154 char *psz_mode, *psz_file, *psz_rrd_file;
157 msg_Info( p_intf, "Using logger..." );
159 /* Allocate instance and initialize some members */
160 p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
161 if( p_intf->p_sys == NULL )
163 msg_Err( p_intf, "out of memory" );
167 psz_mode = var_CreateGetString( p_intf, "logmode" );
170 if( !strcmp( psz_mode, "text" ) )
172 p_intf->p_sys->i_mode = MODE_TEXT;
174 else if( !strcmp( psz_mode, "html" ) )
176 p_intf->p_sys->i_mode = MODE_HTML;
179 else if( !strcmp( psz_mode, "syslog" ) )
181 p_intf->p_sys->i_mode = MODE_SYSLOG;
186 msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
187 p_intf->p_sys->i_mode = MODE_TEXT;
194 msg_Warn( p_intf, "no log mode specified, using `text'" );
195 p_intf->p_sys->i_mode = MODE_TEXT;
198 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
200 psz_file = config_GetPsz( p_intf, "logfile" );
204 char *psz_homedir = p_this->p_vlc->psz_homedir;
208 msg_Err( p_this, "Unable to find home directory" );
211 psz_file = (char *)malloc( sizeof("/" LOG_DIR "/" LOG_FILE_HTML) +
212 strlen(psz_homedir) );
215 switch( p_intf->p_sys->i_mode )
218 sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_HTML,
223 sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_TEXT,
229 switch( p_intf->p_sys->i_mode )
232 psz_file = strdup( LOG_FILE_HTML );
236 psz_file = strdup( LOG_FILE_TEXT );
240 msg_Warn( p_intf, "no log filename provided, using `%s'",
244 /* Open the log file and remove any buffering for the stream */
245 msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
246 p_intf->p_sys->p_file = utf8_fopen( psz_file, "wt" );
247 if( p_intf->p_sys->p_file == NULL )
249 msg_Err( p_intf, "error opening logfile `%s'", psz_file );
250 free( p_intf->p_sys );
254 setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
258 switch( p_intf->p_sys->i_mode )
261 LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
265 LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
272 p_intf->p_sys->p_file = NULL;
274 openlog( "VLC", 0, LOG_DAEMON );
278 p_intf->p_sys->last_update = 0;
279 p_intf->p_sys->p_rrd = NULL;
281 psz_rrd_file = config_GetPsz( p_intf, "rrd-file" );
282 if( psz_rrd_file && *psz_rrd_file )
284 p_intf->p_sys->p_rrd = utf8_fopen( psz_rrd_file, "w" );
287 p_intf->p_sys->p_sub = msg_Subscribe( p_intf , MSG_QUEUE_NORMAL );
288 p_intf->pf_run = Run;
293 /*****************************************************************************
294 * Close: destroy interface stuff
295 *****************************************************************************/
296 static void Close( vlc_object_t *p_this )
298 intf_thread_t *p_intf = (intf_thread_t *)p_this;
300 /* Flush the queue and unsubscribe from the message queue */
301 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
302 p_intf->p_sys->i_mode );
303 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
305 switch( p_intf->p_sys->i_mode )
308 LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
317 LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
321 /* Close the log file */
322 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
323 fclose( p_intf->p_sys->p_file );
325 /* Destroy structure */
326 free( p_intf->p_sys );
329 /*****************************************************************************
331 *****************************************************************************
332 * This part of the interface is in a separate thread so that we can call
333 * exec() from within it without annoying the rest of the program.
334 *****************************************************************************/
335 static void Run( intf_thread_t *p_intf )
337 while( !p_intf->b_die )
339 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
340 p_intf->p_sys->i_mode );
342 if( p_intf->p_sys->p_rrd )
345 msleep( INTF_IDLE_SLEEP );
349 /*****************************************************************************
350 * FlushQueue: flush the message queue into the log
351 *****************************************************************************/
352 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode )
356 vlc_mutex_lock( p_sub->p_lock );
357 i_stop = *p_sub->pi_stop;
358 vlc_mutex_unlock( p_sub->p_lock );
360 if( p_sub->i_start != i_stop )
362 /* Append all messages to log file */
363 for( i_start = p_sub->i_start;
365 i_start = (i_start+1) % VLC_MSG_QSIZE )
370 HtmlPrint( &p_sub->p_msg[i_start], p_file );
374 SyslogPrint( &p_sub->p_msg[i_start] );
379 TextPrint( &p_sub->p_msg[i_start], p_file );
384 vlc_mutex_lock( p_sub->p_lock );
385 p_sub->i_start = i_start;
386 vlc_mutex_unlock( p_sub->p_lock );
390 static const char *ppsz_type[4] = { ": ", " error: ",
391 " warning: ", " debug: " };
393 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
395 LOG_STRING( p_msg->psz_module, p_file );
396 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
397 LOG_STRING( p_msg->psz_msg, p_file );
398 LOG_STRING( "\n", p_file );
402 static void SyslogPrint( const msg_item_t *p_msg )
404 int i_priority = LOG_INFO;
406 if( p_msg->i_type == 0 ) i_priority = LOG_INFO;
407 if( p_msg->i_type == 1 ) i_priority = LOG_ERR;
408 if( p_msg->i_type == 2 ) i_priority = LOG_WARNING;
409 if( p_msg->i_type == 3 ) i_priority = LOG_DEBUG;
411 if( p_msg->psz_header )
412 syslog( i_priority, "%s %s: %s", p_msg->psz_header,
413 p_msg->psz_module, p_msg->psz_msg );
415 syslog( i_priority, "%s: %s", p_msg->psz_module, p_msg->psz_msg );
420 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
422 static const char *ppsz_color[4] = { "<font color=\"#ffffff\">",
423 "<font color=\"#ff6666\">",
424 "<font color=\"#ffff66\">",
425 "<font color=\"#aaaaaa\">" };
427 LOG_STRING( p_msg->psz_module, p_file );
428 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
429 LOG_STRING( ppsz_color[p_msg->i_type], p_file );
430 LOG_STRING( p_msg->psz_msg, p_file );
431 LOG_STRING( "</font>\n", p_file );
434 static void DoRRD( intf_thread_t *p_intf )
436 playlist_t *p_playlist;
437 float f_input_bitrate;
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":"I64Fd".%03u:"I64Fd".%03u:"I64Fd".%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 );