* ./modules/misc/memcpy/memcpyaltivec.c: added a missing AltiVec requirement.
[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.1 2002/08/04 17:23:43 sam 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     setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
164
165     p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
166
167     if( p_intf->p_sys->p_file == NULL )
168     {
169         msg_Err( p_intf, "error opening logfile `%s'", psz_file );
170         free( p_intf->p_sys );
171         msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
172         free( psz_file );
173         return -1;
174     }
175
176     free( psz_file );
177
178     switch( p_intf->p_sys->i_mode )
179     {
180     case MODE_HTML:
181         LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
182         break;
183     case MODE_TEXT:
184     default:
185         LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
186         break;
187     }
188
189     return 0;
190 }
191
192 /*****************************************************************************
193  * Close: destroy interface stuff
194  *****************************************************************************/
195 static void Close( vlc_object_t *p_this )
196 {       
197     intf_thread_t *p_intf = (intf_thread_t *)p_this;
198         
199     /* Flush the queue and unsubscribe from the message queue */
200     FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
201                 p_intf->p_sys->i_mode );
202     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
203
204     switch( p_intf->p_sys->i_mode )
205     {
206     case MODE_HTML:
207         LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
208         break;
209     case MODE_TEXT:
210     default:
211         LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
212         break;
213     }
214
215     /* Close the log file */
216     fclose( p_intf->p_sys->p_file );
217
218     /* Destroy structure */
219     free( p_intf->p_sys );
220 }
221
222 /*****************************************************************************
223  * Run: rc thread
224  *****************************************************************************
225  * This part of the interface is in a separate thread so that we can call
226  * exec() from within it without annoying the rest of the program.
227  *****************************************************************************/
228 static void Run( intf_thread_t *p_intf )
229 {
230     while( !p_intf->b_die )
231     {
232         FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
233                     p_intf->p_sys->i_mode );
234
235         msleep( INTF_IDLE_SLEEP );
236     }
237 }
238
239 /*****************************************************************************
240  * FlushQueue: flush the message queue into the log file
241  *****************************************************************************/
242 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode )
243 {
244     int i_start, i_stop;
245
246     vlc_mutex_lock( p_sub->p_lock );
247     i_stop = *p_sub->pi_stop;
248     vlc_mutex_unlock( p_sub->p_lock );
249
250     if( p_sub->i_start != i_stop )
251     {
252         /* Append all messages to log file */
253         for( i_start = p_sub->i_start;
254              i_start != i_stop;
255              i_start = (i_start+1) % VLC_MSG_QSIZE )
256         {
257             switch( i_mode )
258             {
259             case MODE_HTML:
260                 HtmlPrint( &p_sub->p_msg[i_start], p_file );
261                 break;
262             case MODE_TEXT:
263             default:
264                 TextPrint( &p_sub->p_msg[i_start], p_file );
265                 break;
266             }
267         }
268
269         vlc_mutex_lock( p_sub->p_lock );
270         p_sub->i_start = i_start;
271         vlc_mutex_unlock( p_sub->p_lock );
272     }
273 }
274
275 static const char *ppsz_type[4] = { ": ", " error: ",
276                                     " warning: ", " debug: " };
277
278 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
279 {
280     LOG_STRING( p_msg->psz_module, p_file );
281     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
282     LOG_STRING( p_msg->psz_msg, p_file );
283     LOG_STRING( "\n", p_file );
284 }
285
286 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
287 {
288     static const char *ppsz_color[4] = { "<font color=\"#ffffff\">",
289                                          "<font color=\"#ff6666\">",
290                                          "<font color=\"#ffff66\">",
291                                          "<font color=\"#aaaaaa\">" };
292
293     LOG_STRING( p_msg->psz_module, p_file );
294     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
295     LOG_STRING( ppsz_color[p_msg->i_type], p_file );
296     LOG_STRING( p_msg->psz_msg, p_file );
297     LOG_STRING( "</font>\n", p_file );
298 }
299