1e30ceffc912e4b388c0814e24aec5aa32cdf582
[vlc.git] / modules / misc / logger / logger.c
1 /*****************************************************************************
2  * logger.c : file logging plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2002 VideoLAN
5  * $Id: logger.c,v 1.2 2002/08/24 17:04:36 gbazin Exp $
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>
29
30 #include <errno.h>                                                 /* ENOMEM */
31 #include <stdio.h>
32
33 #include <vlc/vlc.h>
34 #include <vlc/intf.h>
35
36 #define MODE_TEXT 0
37 #define MODE_HTML 1
38
39 #define LOG_FILE "vlc-log.txt"
40 #define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );
41
42 #define TEXT_HEADER "-- logger module started --\n"
43 #define TEXT_FOOTER "-- logger module stopped --\n"
44
45 #define HTML_HEADER \
46     "<html>\n" \
47     "  <head>\n" \
48     "    <title>vlc log</title>\n" \
49     "  </head>\n" \
50     "  <body bgcolor=\"#000000\" text=\"#aaaaaa\">\n" \
51     "    <pre>\n" \
52     "      <b>-- logger module started --</b>\n"
53 #define HTML_FOOTER \
54     "      <b>-- logger module stopped --</b>\n" \
55     "    </pre>\n" \
56     "  </body>\n" \
57     "</html>\n"
58
59 /*****************************************************************************
60  * intf_sys_t: description and status of log interface
61  *****************************************************************************/
62 struct intf_sys_t
63 {
64     int i_mode;
65
66     FILE *    p_file; /* The log file */
67     msg_subscription_t *p_sub;
68 };
69
70 /*****************************************************************************
71  * Local prototypes
72  *****************************************************************************/
73 static int  Open    ( vlc_object_t * );                  
74 static void Close   ( vlc_object_t * );
75 static void Run     ( intf_thread_t * );
76
77 static void FlushQueue        ( msg_subscription_t *, FILE *, int );
78 static void TextPrint         ( const msg_item_t *, FILE * );
79 static void HtmlPrint         ( const msg_item_t *, FILE * );
80
81 /*****************************************************************************
82  * Module descriptor
83  *****************************************************************************/
84 vlc_module_begin();
85     add_category_hint( N_("Miscellaneous"), NULL );
86     add_string( "logfile", NULL, NULL, N_("log filename"), N_("Specify the log filename.") );
87     add_string( "logmode", NULL, NULL, N_("log format"), N_("Specify the log format. Available choices are \"text\" (default) and \"html\"") );
88     set_description( _("file logging interface module") );
89     set_capability( "interface", 0 );
90     set_callbacks( Open, Close );
91 vlc_module_end();
92
93 /*****************************************************************************
94  * Open: initialize and create stuff
95  *****************************************************************************/
96 static int Open( vlc_object_t *p_this )
97 {   
98     intf_thread_t *p_intf = (intf_thread_t *)p_this;
99     char *psz_mode, *psz_file;
100
101 #ifdef WIN32
102     AllocConsole();
103     freopen( "CONOUT$", "w", stdout );
104     freopen( "CONOUT$", "w", stderr );
105     freopen( "CONIN$", "r", stdin );
106     msg_Info( p_intf, VERSION_MESSAGE );
107     msg_Info( p_intf, _("\nUsing the logger interface plugin...") );
108 #endif
109
110     /* Allocate instance and initialize some members */
111     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
112     if( p_intf->p_sys == NULL )
113     {
114         msg_Err( p_intf, "out of memory" );
115         return -1;
116     }
117
118     psz_mode = config_GetPsz( p_intf, "logmode" );
119     if( psz_mode )
120     {
121         if( !strcmp( psz_mode, "text" ) )
122         {
123             p_intf->p_sys->i_mode = MODE_TEXT;
124         }
125         else if( !strcmp( psz_mode, "html" ) )
126         {
127             p_intf->p_sys->i_mode = MODE_HTML;
128         }
129         else
130         {
131             msg_Err( p_intf, "invalid log mode `%s', using `text'", psz_mode );
132             p_intf->p_sys->i_mode = MODE_TEXT;
133         }
134
135         free( psz_mode );
136     }
137     else
138     {
139         msg_Warn( p_intf, "no log mode specified, using `text'" );
140         p_intf->p_sys->i_mode = MODE_TEXT;
141     }
142
143     psz_file = config_GetPsz( p_intf, "logfile" );
144     if( !psz_file )
145     {
146         switch( p_intf->p_sys->i_mode )
147         {
148         case MODE_HTML:
149             psz_file = strdup( "vlc-log.html" );
150             break;
151         case MODE_TEXT:
152         default:
153             psz_file = strdup( "vlc-log.txt" );
154             break;
155         }
156
157         msg_Warn( p_intf, "no log filename provided, using `%s'", psz_file );
158     }
159
160     /* Open the log file and remove any buffering for the stream */
161     msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
162     p_intf->p_sys->p_file = fopen( psz_file, "wt" );
163     if( p_intf->p_sys->p_file == NULL )
164     {
165         msg_Err( p_intf, "error opening logfile `%s'", psz_file );
166         free( p_intf->p_sys );
167         free( psz_file );
168         return -1;
169     }
170     setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
171     p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
172
173     free( psz_file );
174
175     switch( p_intf->p_sys->i_mode )
176     {
177     case MODE_HTML:
178         LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
179         break;
180     case MODE_TEXT:
181     default:
182         LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
183         break;
184     }
185
186     p_intf->pf_run = Run;
187
188     return 0;
189 }
190
191 /*****************************************************************************
192  * Close: destroy interface stuff
193  *****************************************************************************/
194 static void Close( vlc_object_t *p_this )
195 {       
196     intf_thread_t *p_intf = (intf_thread_t *)p_this;
197         
198     /* Flush the queue and unsubscribe from the message queue */
199     FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
200                 p_intf->p_sys->i_mode );
201     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
202
203     switch( p_intf->p_sys->i_mode )
204     {
205     case MODE_HTML:
206         LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
207         break;
208     case MODE_TEXT:
209     default:
210         LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
211         break;
212     }
213
214     /* Close the log file */
215     fclose( p_intf->p_sys->p_file );
216
217     /* Destroy structure */
218     free( p_intf->p_sys );
219 }
220
221 /*****************************************************************************
222  * Run: rc thread
223  *****************************************************************************
224  * This part of the interface is in a separate thread so that we can call
225  * exec() from within it without annoying the rest of the program.
226  *****************************************************************************/
227 static void Run( intf_thread_t *p_intf )
228 {
229     while( !p_intf->b_die )
230     {
231         FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
232                     p_intf->p_sys->i_mode );
233
234         msleep( INTF_IDLE_SLEEP );
235     }
236 }
237
238 /*****************************************************************************
239  * FlushQueue: flush the message queue into the log file
240  *****************************************************************************/
241 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode )
242 {
243     int i_start, i_stop;
244
245     vlc_mutex_lock( p_sub->p_lock );
246     i_stop = *p_sub->pi_stop;
247     vlc_mutex_unlock( p_sub->p_lock );
248
249     if( p_sub->i_start != i_stop )
250     {
251         /* Append all messages to log file */
252         for( i_start = p_sub->i_start;
253              i_start != i_stop;
254              i_start = (i_start+1) % VLC_MSG_QSIZE )
255         {
256             switch( i_mode )
257             {
258             case MODE_HTML:
259                 HtmlPrint( &p_sub->p_msg[i_start], p_file );
260                 break;
261             case MODE_TEXT:
262             default:
263                 TextPrint( &p_sub->p_msg[i_start], p_file );
264                 break;
265             }
266         }
267
268         vlc_mutex_lock( p_sub->p_lock );
269         p_sub->i_start = i_start;
270         vlc_mutex_unlock( p_sub->p_lock );
271     }
272 }
273
274 static const char *ppsz_type[4] = { ": ", " error: ",
275                                     " warning: ", " debug: " };
276
277 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
278 {
279     LOG_STRING( p_msg->psz_module, p_file );
280     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
281     LOG_STRING( p_msg->psz_msg, p_file );
282     LOG_STRING( "\n", p_file );
283 }
284
285 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
286 {
287     static const char *ppsz_color[4] = { "<font color=\"#ffffff\">",
288                                          "<font color=\"#ff6666\">",
289                                          "<font color=\"#ffff66\">",
290                                          "<font color=\"#aaaaaa\">" };
291
292     LOG_STRING( p_msg->psz_module, p_file );
293     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
294     LOG_STRING( ppsz_color[p_msg->i_type], p_file );
295     LOG_STRING( p_msg->psz_msg, p_file );
296     LOG_STRING( "</font>\n", p_file );
297 }
298