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
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>
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 TEXT_HEADER "-- logger module started --\n"
56 #define TEXT_FOOTER "-- logger module stopped --\n"
59 "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
60 " \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
63 " <title>vlc log</title>\n" \
64 " <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" \
66 " <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
68 " <b>-- logger module started --</b>\n"
70 " <b>-- logger module stopped --</b>\n" \
81 intf_thread_t *p_intf;
86 /*****************************************************************************
87 * intf_sys_t: description and status of log interface
88 *****************************************************************************/
97 msg_subscription_t *p_sub;
101 /*****************************************************************************
103 *****************************************************************************/
104 static int Open ( vlc_object_t * );
105 static void Close ( vlc_object_t * );
107 static void Overflow (msg_cb_data_t *p_sys, msg_item_t *p_item, unsigned overruns);
108 static void TextPrint ( const msg_item_t *, FILE * );
109 static void HtmlPrint ( const msg_item_t *, FILE * );
111 static void SyslogPrint ( const msg_item_t *);
114 static void *DoRRD( void * );
116 /*****************************************************************************
118 *****************************************************************************/
119 static const char *const mode_list[] = { "text", "html"
124 static const char *const mode_list_text[] = { N_("Text"), "HTML"
130 #define LOGMODE_TEXT N_("Log format")
132 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
133 "\"text\" (default), \"html\", and \"syslog\" (special mode to send to " \
134 "syslog instead of file.")
136 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
137 "\"text\" (default) and \"html\".")
141 set_shortname( N_( "Logging" ) )
142 set_description( N_("File logging") )
144 set_category( CAT_ADVANCED )
145 set_subcategory( SUBCAT_ADVANCED_MISC )
147 add_file( "logfile", NULL, NULL,
148 N_("Log filename"), N_("Specify the log filename."), false );
149 add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
151 change_string_list( mode_list, mode_list_text, 0 );
153 add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
154 N_("Output data for RRDTool in this file." ), true );
156 set_capability( "interface", 0 )
157 set_callbacks( Open, Close )
160 /*****************************************************************************
161 * Open: initialize and create stuff
162 *****************************************************************************/
163 static int Open( vlc_object_t *p_this )
165 intf_thread_t *p_intf = (intf_thread_t *)p_this;
167 char *psz_mode, *psz_rrd_file;
170 msg_Info( p_intf, "using logger..." );
172 /* Allocate instance and initialize some members */
173 p_sys = p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
177 p_sys->msg.p_intf = p_intf;
178 p_sys->msg.i_mode = MODE_TEXT;
179 psz_mode = var_CreateGetString( p_intf, "logmode" );
182 if( !strcmp( psz_mode, "text" ) )
184 else if( !strcmp( psz_mode, "html" ) )
186 p_sys->msg.i_mode = MODE_HTML;
189 else if( !strcmp( psz_mode, "syslog" ) )
191 p_sys->msg.i_mode = MODE_SYSLOG;
196 msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
197 p_sys->msg.i_mode = MODE_TEXT;
203 msg_Warn( p_intf, "no log mode specified, using `text'" );
206 if( p_sys->msg.i_mode != MODE_SYSLOG )
208 char *psz_file = config_GetPsz( p_intf, "logfile" );
212 if( asprintf( &psz_file, "%s/"LOG_DIR"/%s", config_GetHomeDir(),
213 (p_sys->msg.i_mode == MODE_HTML) ? LOG_FILE_HTML
214 : LOG_FILE_TEXT ) == -1 )
217 switch( p_sys->msg.i_mode )
220 psz_file = strdup( LOG_FILE_HTML );
224 psz_file = strdup( LOG_FILE_TEXT );
228 msg_Warn( p_intf, "no log filename provided, using `%s'",
232 /* Open the log file and remove any buffering for the stream */
233 msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
234 p_sys->msg.p_file = utf8_fopen( psz_file, "at" );
235 if( p_sys->msg.p_file == NULL )
237 msg_Err( p_intf, "error opening logfile `%s'", psz_file );
242 setvbuf( p_sys->msg.p_file, NULL, _IONBF, 0 );
246 switch( p_sys->msg.i_mode )
249 fputs( HTML_HEADER, p_sys->msg.p_file );
253 fputs( TEXT_HEADER, p_sys->msg.p_file );
260 p_sys->msg.p_file = NULL;
262 openlog( "vlc", LOG_PID|LOG_NDELAY, LOG_DAEMON );
266 psz_rrd_file = config_GetPsz( p_intf, "rrd-file" );
267 if( psz_rrd_file && *psz_rrd_file )
269 FILE *rrd = utf8_fopen( psz_rrd_file, "w" );
272 setvbuf (rrd, NULL, _IOLBF, BUFSIZ);
273 if (!vlc_clone (&p_sys->rrd.thread, DoRRD, p_intf,
274 VLC_THREAD_PRIORITY_LOW))
275 p_sys->rrd.stream = rrd;
279 p_sys->rrd.stream = NULL;
284 p_sys->rrd.stream = NULL;
285 free( psz_rrd_file );
287 p_sys->p_sub = msg_Subscribe( p_intf->p_libvlc, Overflow, &p_sys->msg );
292 /*****************************************************************************
293 * Close: destroy interface stuff
294 *****************************************************************************/
295 static void Close( vlc_object_t *p_this )
297 intf_thread_t *p_intf = (intf_thread_t *)p_this;
298 intf_sys_t *p_sys = p_intf->p_sys;
300 if (p_sys->rrd.stream)
302 vlc_cancel (p_sys->rrd.thread);
303 vlc_join (p_sys->rrd.thread, NULL);
306 /* Flush the queue and unsubscribe from the message queue */
308 msg_Unsubscribe( p_sys->p_sub );
310 switch( p_sys->msg.i_mode )
313 fputs( HTML_FOOTER, p_sys->msg.p_file );
322 fputs( TEXT_FOOTER, p_sys->msg.p_file );
326 /* Close the log file */
327 if( p_sys->msg.p_file )
328 fclose( p_sys->msg.p_file );
330 /* Destroy structure */
337 static void Overflow (msg_cb_data_t *p_sys, msg_item_t *p_item, unsigned overruns)
339 int verbosity = var_CreateGetInteger( p_sys->p_intf, "verbose" );
342 switch( p_item->i_type )
344 case VLC_MSG_WARN: priority = 1; break;
345 case VLC_MSG_DBG: priority = 2; break;
347 if (verbosity < priority)
350 switch( p_sys->i_mode )
353 HtmlPrint( p_item, p_sys->p_file );
357 SyslogPrint( p_item );
362 TextPrint( p_item, p_sys->p_file );
367 static const char ppsz_type[4][11] = {
374 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
376 fprintf( p_file, "%s%s%s\n", p_msg->psz_module, ppsz_type[p_msg->i_type],
381 static void SyslogPrint( const msg_item_t *p_msg )
383 static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
384 int i_priority = i_prio[p_msg->i_type];
386 if( p_msg->psz_header )
387 syslog( i_priority, "%s%s %s: %s", p_msg->psz_header,
388 ppsz_type[p_msg->i_type],
389 p_msg->psz_module, p_msg->psz_msg );
391 syslog( i_priority, "%s%s: %s", p_msg->psz_module,
392 ppsz_type[p_msg->i_type], p_msg->psz_msg );
397 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
399 static const char ppsz_color[4][30] = {
400 "<span style=\"color: #ffffff\">",
401 "<span style=\"color: #ff6666\">",
402 "<span style=\"color: #ffff66\">",
403 "<span style=\"color: #aaaaaa\">",
406 fprintf( p_file, "%s%s%s%s</span>\n", p_msg->psz_module,
407 ppsz_type[p_msg->i_type], ppsz_color[p_msg->i_type],
411 static void *DoRRD (void *data)
413 intf_thread_t *p_intf = data;
414 FILE *file = p_intf->p_sys->rrd.stream;
418 /* FIXME: I wonder how memory synchronization occurs here...
420 if( p_intf->p_libvlc->p_stats )
422 lldiv_t in = lldiv( p_intf->p_libvlc->p_stats->f_input_bitrate * 1000000,
424 lldiv_t dm = lldiv( p_intf->p_libvlc->p_stats->f_demux_bitrate * 1000000,
426 lldiv_t out = lldiv( p_intf->p_libvlc->p_stats->f_output_bitrate * 1000000,
429 "%"PRIi64":%lld.%03llu:%lld.%03llu:%lld.%03llu\n",
430 (int64_t)time(NULL), in.quot, in.rem, dm.quot, dm.rem, out.quot, out.rem );
432 #undef msleep /* yeah, we really want to wake up every second here */