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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
30 #include <errno.h> /* ENOMEM */
34 # define _IONBF 0x0004
45 #define LOG_DIR "Library/Logs/"
48 #define LOG_FILE_TEXT "vlc-log.txt"
49 #define LOG_FILE_HTML "vlc-log.html"
51 #define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );
53 #define TEXT_HEADER "-- logger module started --\n"
54 #define TEXT_FOOTER "-- logger module stopped --\n"
59 " <title>vlc log</title>\n" \
61 " <body bgcolor=\"#000000\" text=\"#aaaaaa\">\n" \
63 " <b>-- logger module started --</b>\n"
65 " <b>-- logger module stopped --</b>\n" \
74 /*****************************************************************************
75 * intf_sys_t: description and status of log interface
76 *****************************************************************************/
81 FILE * p_file; /* The log file */
82 msg_subscription_t *p_sub;
85 /*****************************************************************************
87 *****************************************************************************/
88 static int Open ( vlc_object_t * );
89 static void Close ( vlc_object_t * );
90 static void Run ( intf_thread_t * );
92 static void FlushQueue ( msg_subscription_t *, FILE *, int );
93 static void TextPrint ( const msg_item_t *, FILE * );
94 static void HtmlPrint ( const msg_item_t *, FILE * );
96 static void SyslogPrint ( const msg_item_t *);
99 /*****************************************************************************
101 *****************************************************************************/
102 static char *mode_list[] = { "text", "html"
107 static char *mode_list_text[] = { N_("Text"), "HTML"
113 #define LOGMODE_TEXT N_("Log format")
115 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are \"text\" (default), \"html\", and \"syslog\".")
117 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are \"text\" (default) and \"html\".")
121 set_category( CAT_INTERFACE );
122 set_subcategory( SUBCAT_INTERFACE_CONTROL );
123 set_shortname( N_( "Logging" ) );
124 set_description( _("File logging") );
126 add_file( "logfile", NULL, NULL, N_("Log filename"), N_("Specify the log filename."), VLC_FALSE );
127 add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
129 change_string_list( mode_list, mode_list_text, 0 );
131 set_capability( "interface", 0 );
132 set_callbacks( Open, Close );
135 /*****************************************************************************
136 * Open: initialize and create stuff
137 *****************************************************************************/
138 static int Open( vlc_object_t *p_this )
140 intf_thread_t *p_intf = (intf_thread_t *)p_this;
141 char *psz_mode, *psz_file;
144 msg_Info( p_intf, "Using logger..." );
146 /* Allocate instance and initialize some members */
147 p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
148 if( p_intf->p_sys == NULL )
150 msg_Err( p_intf, "out of memory" );
154 psz_mode = config_GetPsz( p_intf, "logmode" );
157 if( !strcmp( psz_mode, "text" ) )
159 p_intf->p_sys->i_mode = MODE_TEXT;
161 else if( !strcmp( psz_mode, "html" ) )
163 p_intf->p_sys->i_mode = MODE_HTML;
166 else if( !strcmp( psz_mode, "syslog" ) )
168 p_intf->p_sys->i_mode = MODE_SYSLOG;
173 msg_Err( p_intf, "invalid log mode `%s', using `text'", psz_mode );
174 p_intf->p_sys->i_mode = MODE_TEXT;
181 msg_Warn( p_intf, "no log mode specified, using `text'" );
182 p_intf->p_sys->i_mode = MODE_TEXT;
185 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
187 psz_file = config_GetPsz( p_intf, "logfile" );
191 char *psz_homedir = p_this->p_vlc->psz_homedir;
195 msg_Err( p_this, "psz_homedir is null" );
198 psz_file = (char *)malloc( sizeof("/" LOG_DIR "/" LOG_FILE_HTML) +
199 strlen(psz_homedir) );
202 switch( p_intf->p_sys->i_mode )
205 sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_HTML,
210 sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_TEXT,
216 switch( p_intf->p_sys->i_mode )
219 psz_file = strdup( LOG_FILE_HTML );
223 psz_file = strdup( LOG_FILE_TEXT );
227 msg_Warn( p_intf, "no log filename provided, using `%s'",
231 /* Open the log file and remove any buffering for the stream */
232 msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
233 p_intf->p_sys->p_file = fopen( psz_file, "wt" );
234 if( p_intf->p_sys->p_file == NULL )
236 msg_Err( p_intf, "error opening logfile `%s'", psz_file );
237 free( p_intf->p_sys );
241 setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
245 switch( p_intf->p_sys->i_mode )
248 LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
252 LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
259 p_intf->p_sys->p_file = NULL;
261 openlog( "VLC", 0, LOG_DAEMON );
265 p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
266 p_intf->pf_run = Run;
271 /*****************************************************************************
272 * Close: destroy interface stuff
273 *****************************************************************************/
274 static void Close( vlc_object_t *p_this )
276 intf_thread_t *p_intf = (intf_thread_t *)p_this;
278 /* Flush the queue and unsubscribe from the message queue */
279 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
280 p_intf->p_sys->i_mode );
281 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
283 switch( p_intf->p_sys->i_mode )
286 LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
295 LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
299 /* Close the log file */
300 if( p_intf->p_sys->i_mode != MODE_SYSLOG )
301 fclose( p_intf->p_sys->p_file );
303 /* Destroy structure */
304 free( p_intf->p_sys );
307 /*****************************************************************************
309 *****************************************************************************
310 * This part of the interface is in a separate thread so that we can call
311 * exec() from within it without annoying the rest of the program.
312 *****************************************************************************/
313 static void Run( intf_thread_t *p_intf )
315 while( !p_intf->b_die )
317 FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
318 p_intf->p_sys->i_mode );
320 msleep( INTF_IDLE_SLEEP );
324 /*****************************************************************************
325 * FlushQueue: flush the message queue into the log
326 *****************************************************************************/
327 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode )
331 vlc_mutex_lock( p_sub->p_lock );
332 i_stop = *p_sub->pi_stop;
333 vlc_mutex_unlock( p_sub->p_lock );
335 if( p_sub->i_start != i_stop )
337 /* Append all messages to log file */
338 for( i_start = p_sub->i_start;
340 i_start = (i_start+1) % VLC_MSG_QSIZE )
345 HtmlPrint( &p_sub->p_msg[i_start], p_file );
349 SyslogPrint( &p_sub->p_msg[i_start] );
354 TextPrint( &p_sub->p_msg[i_start], p_file );
359 vlc_mutex_lock( p_sub->p_lock );
360 p_sub->i_start = i_start;
361 vlc_mutex_unlock( p_sub->p_lock );
365 static const char *ppsz_type[4] = { ": ", " error: ",
366 " warning: ", " debug: " };
368 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
370 LOG_STRING( p_msg->psz_module, p_file );
371 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
372 LOG_STRING( p_msg->psz_msg, p_file );
373 LOG_STRING( "\n", p_file );
377 static void SyslogPrint( const msg_item_t *p_msg )
379 int i_priority = LOG_INFO;
381 if( p_msg->i_type == 0 ) i_priority = LOG_INFO;
382 if( p_msg->i_type == 1 ) i_priority = LOG_ERR;
383 if( p_msg->i_type == 2 ) i_priority = LOG_WARNING;
384 if( p_msg->i_type == 3 ) i_priority = LOG_DEBUG;
386 syslog( i_priority, "%s %s", p_msg->psz_module, p_msg->psz_msg );
390 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
392 static const char *ppsz_color[4] = { "<font color=\"#ffffff\">",
393 "<font color=\"#ff6666\">",
394 "<font color=\"#ffff66\">",
395 "<font color=\"#aaaaaa\">" };
397 LOG_STRING( p_msg->psz_module, p_file );
398 LOG_STRING( ppsz_type[p_msg->i_type], p_file );
399 LOG_STRING( ppsz_color[p_msg->i_type], p_file );
400 LOG_STRING( p_msg->psz_msg, p_file );
401 LOG_STRING( "</font>\n", p_file );