Use setvbuf instead of repeated fflush
[vlc.git] / modules / misc / logger.c
1 /*****************************************************************************
2  * logger.c : file logging plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2002 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
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>
37
38 #include <errno.h>                                                 /* ENOMEM */
39
40 #ifdef UNDER_CE
41 #   define _IONBF 0x0004
42 #endif
43
44 #define MODE_TEXT 0
45 #define MODE_HTML 1
46 #define MODE_SYSLOG 2
47
48 #ifdef __APPLE__
49 #define LOG_DIR "Library/Logs/"
50 #endif
51
52 #define LOG_FILE_TEXT "vlc-log.txt"
53 #define LOG_FILE_HTML "vlc-log.html"
54
55 #define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );
56
57 #define TEXT_HEADER "-- logger module started --\n"
58 #define TEXT_FOOTER "-- logger module stopped --\n"
59
60 #define HTML_HEADER \
61     "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
62     "  \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
63     "<html>\n" \
64     "  <head>\n" \
65     "    <title>vlc log</title>\n" \
66     "    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" \
67     "  </head>\n" \
68     "  <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
69     "    <pre>\n" \
70     "      <b>-- logger module started --</b>\n"
71 #define HTML_FOOTER \
72     "      <b>-- logger module stopped --</b>\n" \
73     "    </pre>\n" \
74     "  </body>\n" \
75     "</html>\n"
76
77 #if HAVE_SYSLOG_H
78 #include <syslog.h>
79 #endif
80
81 /*****************************************************************************
82  * intf_sys_t: description and status of log interface
83  *****************************************************************************/
84 struct intf_sys_t
85 {
86     int i_mode;
87     FILE *p_rrd;
88     mtime_t last_update;
89     time_t now;  /* timestamp for rrd-log */
90
91     FILE *    p_file; /* The log file */
92     msg_subscription_t *p_sub;
93 };
94
95 /*****************************************************************************
96  * Local prototypes
97  *****************************************************************************/
98 static int  Open    ( vlc_object_t * );
99 static void Close   ( vlc_object_t * );
100 static void Run     ( intf_thread_t * );
101
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 * );
105 #ifdef HAVE_SYSLOG_H
106 static void SyslogPrint       ( const msg_item_t *);
107 #endif
108
109 static void DoRRD( intf_thread_t *p_intf );
110
111 /*****************************************************************************
112  * Module descriptor
113  *****************************************************************************/
114 static const char *const mode_list[] = { "text", "html"
115 #ifdef HAVE_SYSLOG_H
116 ,"syslog"
117 #endif
118 };
119 static const char *const mode_list_text[] = { N_("Text"), "HTML"
120 #ifdef HAVE_SYSLOG_H
121 , "syslog"
122 #endif
123 };
124
125 #define LOGMODE_TEXT N_("Log format")
126 #ifdef HAVE_SYSLOG_H
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.")
130 #else
131 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
132   "\"text\" (default) and \"html\".")
133 #endif
134
135 vlc_module_begin();
136     set_shortname( N_( "Logging" ) );
137     set_description( N_("File logging") );
138
139     set_category( CAT_ADVANCED );
140     set_subcategory( SUBCAT_ADVANCED_MISC );
141
142     add_file( "logfile", NULL, NULL,
143              N_("Log filename"), N_("Specify the log filename."), false );
144     add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
145                 false );
146         change_string_list( mode_list, mode_list_text, 0 );
147
148     add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
149                     N_("Output data for RRDTool in this file." ), true );
150
151     set_capability( "interface", 0 );
152     set_callbacks( Open, Close );
153 vlc_module_end();
154
155 /*****************************************************************************
156  * Open: initialize and create stuff
157  *****************************************************************************/
158 static int Open( vlc_object_t *p_this )
159 {
160     intf_thread_t *p_intf = (intf_thread_t *)p_this;
161     char *psz_mode, *psz_file, *psz_rrd_file;
162
163     CONSOLE_INTRO_MSG;
164     msg_Info( p_intf, "using logger..." );
165
166     /* Allocate instance and initialize some members */
167     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
168     if( p_intf->p_sys == NULL )
169         return -1;
170
171     psz_mode = var_CreateGetString( p_intf, "logmode" );
172     if( psz_mode )
173     {
174         if( !strcmp( psz_mode, "text" ) )
175         {
176             p_intf->p_sys->i_mode = MODE_TEXT;
177         }
178         else if( !strcmp( psz_mode, "html" ) )
179         {
180             p_intf->p_sys->i_mode = MODE_HTML;
181         }
182 #ifdef HAVE_SYSLOG_H
183         else if( !strcmp( psz_mode, "syslog" ) )
184         {
185             p_intf->p_sys->i_mode = MODE_SYSLOG;
186         }
187 #endif
188         else
189         {
190             msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
191             p_intf->p_sys->i_mode = MODE_TEXT;
192         }
193
194         free( psz_mode );
195     }
196     else
197     {
198         msg_Warn( p_intf, "no log mode specified, using `text'" );
199         p_intf->p_sys->i_mode = MODE_TEXT;
200     }
201
202     if( p_intf->p_sys->i_mode != MODE_SYSLOG )
203     {
204         psz_file = config_GetPsz( p_intf, "logfile" );
205         if( !psz_file )
206         {
207 #ifdef __APPLE__
208             if( asprintf( &psz_file, "%s/"LOG_DIR"/%s", config_GetHomeDir(),
209                 (p_intf->p_sys->i_mode == MODE_HTML) ? LOG_FILE_HTML
210                                                      : LOG_FILE_TEXT ) == -1 )
211                 psz_file = NULL;
212 #else
213             switch( p_intf->p_sys->i_mode )
214             {
215             case MODE_HTML:
216                 psz_file = strdup( LOG_FILE_HTML );
217                 break;
218             case MODE_TEXT:
219             default:
220                 psz_file = strdup( LOG_FILE_TEXT );
221                 break;
222             }
223 #endif
224             msg_Warn( p_intf, "no log filename provided, using `%s'",
225                                psz_file );
226         }
227
228         /* Open the log file and remove any buffering for the stream */
229         msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
230         p_intf->p_sys->p_file = utf8_fopen( psz_file, "at" );
231         if( p_intf->p_sys->p_file == NULL )
232         {
233             msg_Err( p_intf, "error opening logfile `%s'", psz_file );
234             free( p_intf->p_sys );
235             free( psz_file );
236             return -1;
237         }
238         setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
239
240         free( psz_file );
241
242         switch( p_intf->p_sys->i_mode )
243         {
244         case MODE_HTML:
245             LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
246             break;
247         case MODE_TEXT:
248         default:
249             LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
250             break;
251         }
252
253     }
254     else
255     {
256         p_intf->p_sys->p_file = NULL;
257 #ifdef HAVE_SYSLOG_H
258         openlog( "vlc", LOG_PID|LOG_NDELAY, LOG_DAEMON );
259 #endif
260     }
261
262     p_intf->p_sys->last_update = 0;
263     p_intf->p_sys->p_rrd = NULL;
264
265     psz_rrd_file = config_GetPsz( p_intf, "rrd-file" );
266     if( psz_rrd_file && *psz_rrd_file )
267     {
268         p_intf->p_sys->p_rrd = utf8_fopen( psz_rrd_file, "w" );
269         if (p_intf->p_sys->p_rrd != NULL)
270             setvbuf (p_intf->p_sys->p_rrd, NULL, _IOLBF, BUFSIZ);
271     }
272     free( psz_rrd_file );
273
274     p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
275     p_intf->pf_run = Run;
276
277     return 0;
278 }
279
280 /*****************************************************************************
281  * Close: destroy interface stuff
282  *****************************************************************************/
283 static void Close( vlc_object_t *p_this )
284 {
285     intf_thread_t *p_intf = (intf_thread_t *)p_this;
286
287     /* Flush the queue and unsubscribe from the message queue */
288     FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
289                 p_intf->p_sys->i_mode,
290                 var_CreateGetInteger( p_intf, "verbose" ) );
291     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
292
293     switch( p_intf->p_sys->i_mode )
294     {
295     case MODE_HTML:
296         LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
297         break;
298     case MODE_TEXT:
299 #ifdef HAVE_SYSLOG_H
300     case MODE_SYSLOG:
301         closelog();
302         break;
303 #endif
304     default:
305         LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
306         break;
307     }
308
309     /* Close the log file */
310     if( p_intf->p_sys->i_mode != MODE_SYSLOG )
311         fclose( p_intf->p_sys->p_file );
312
313     /* Destroy structure */
314     free( p_intf->p_sys );
315 }
316
317 /*****************************************************************************
318  * Run: rc thread
319  *****************************************************************************
320  * This part of the interface is in a separate thread so that we can call
321  * exec() from within it without annoying the rest of the program.
322  *****************************************************************************/
323 static void Run( intf_thread_t *p_intf )
324 {
325     for( ;; )
326     {
327         int canc = vlc_savecancel();
328         FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
329                     p_intf->p_sys->i_mode,
330                     var_CreateGetInteger( p_intf, "verbose" ) );
331         if( p_intf->p_sys->p_rrd )
332             DoRRD( p_intf );
333
334         vlc_restorecancel( canc );
335         /* FIXME: this is WRONG. */
336         msleep( INTF_IDLE_SLEEP );
337     }
338 }
339
340 /*****************************************************************************
341  * FlushQueue: flush the message queue into the log
342  *****************************************************************************/
343 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode,
344                         int i_verbose )
345 {
346     int i_start, i_stop;
347
348     vlc_mutex_lock( p_sub->p_lock );
349     i_stop = *p_sub->pi_stop;
350     vlc_mutex_unlock( p_sub->p_lock );
351
352     if( p_sub->i_start != i_stop )
353     {
354         /* Append all messages to log file */
355         for( i_start = p_sub->i_start;
356              i_start != i_stop;
357              i_start = (i_start+1) % VLC_MSG_QSIZE )
358         {
359             switch( p_sub->p_msg[i_start].i_type )
360             {
361             case VLC_MSG_ERR:
362                 if( i_verbose < 0 ) continue;
363                 break;
364             case VLC_MSG_INFO:
365                 if( i_verbose < 0 ) continue;
366                 break;
367             case VLC_MSG_WARN:
368                 if( i_verbose < 1 ) continue;
369                 break;
370             case VLC_MSG_DBG:
371                 if( i_verbose < 2 ) continue;
372                 break;
373             }
374
375             switch( i_mode )
376             {
377             case MODE_HTML:
378                 HtmlPrint( &p_sub->p_msg[i_start], p_file );
379                 break;
380 #ifdef HAVE_SYSLOG_H
381             case MODE_SYSLOG:
382                 SyslogPrint( &p_sub->p_msg[i_start] );
383                 break;
384 #endif
385             case MODE_TEXT:
386             default:
387                 TextPrint( &p_sub->p_msg[i_start], p_file );
388                 break;
389             }
390         }
391
392         vlc_mutex_lock( p_sub->p_lock );
393         p_sub->i_start = i_start;
394         vlc_mutex_unlock( p_sub->p_lock );
395     }
396 }
397
398 static const char *ppsz_type[4] = { ": ", " error: ",
399                                     " warning: ", " debug: " };
400
401 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
402 {
403     LOG_STRING( p_msg->psz_module, p_file );
404     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
405     LOG_STRING( p_msg->psz_msg, p_file );
406     LOG_STRING( "\n", p_file );
407 }
408
409 #ifdef HAVE_SYSLOG_H
410 static void SyslogPrint( const msg_item_t *p_msg )
411 {
412     static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
413     int i_priority = i_prio[p_msg->i_type];
414
415     if( p_msg->psz_header )
416         syslog( i_priority, "%s%s %s: %s", p_msg->psz_header,
417                 ppsz_type[p_msg->i_type],
418                 p_msg->psz_module, p_msg->psz_msg );
419     else
420         syslog( i_priority, "%s%s: %s", p_msg->psz_module, 
421                 ppsz_type[p_msg->i_type], p_msg->psz_msg );
422  
423 }
424 #endif
425
426 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
427 {
428     static const char *ppsz_color[4] = { "<span style=\"color: #ffffff\">",
429                                          "<span style=\"color: #ff6666\">",
430                                          "<span style=\"color: #ffff66\">",
431                                          "<span style=\"color: #aaaaaa\">" };
432
433     LOG_STRING( p_msg->psz_module, p_file );
434     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
435     LOG_STRING( ppsz_color[p_msg->i_type], p_file );
436     LOG_STRING( p_msg->psz_msg, p_file );
437     LOG_STRING( "</span>\n", p_file );
438 }
439
440 static void DoRRD( intf_thread_t *p_intf )
441 {
442     mtime_t now = mdate();
443     if( now - p_intf->p_sys->last_update < 1000000 )
444         return;
445     p_intf->p_sys->last_update = now;
446
447     if( p_intf->p_libvlc->p_stats )
448     {
449         time(&p_intf->p_sys->now);
450         lldiv_t in = lldiv( p_intf->p_libvlc->p_stats->f_input_bitrate * 1000000,
451                              1000 );
452         lldiv_t dm = lldiv( p_intf->p_libvlc->p_stats->f_demux_bitrate * 1000000,
453                              1000 );
454         lldiv_t out = lldiv( p_intf->p_libvlc->p_stats->f_output_bitrate * 1000000,
455                              1000 );
456         fprintf( p_intf->p_sys->p_rrd,
457                  "%"PRIi64":%lld.%03llu:%lld.%03llu:%lld.%03llu\n",
458                  now, in.quot, in.rem, dm.quot, dm.rem, out.quot, out.rem );
459     }
460 }