git.sesse.net Git - vlc/blob - 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.7 2003/03/30 18:14:38 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 static char *mode_list[] = { "text", "html", NULL };
  85 #define LOGMODE_TEXT N_("log format")
  86 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are \"text\" (default) and \"html\"")
  87 vlc_module_begin();
  88     add_category_hint( N_("Miscellaneous"), NULL, VLC_FALSE );
  89     add_file( "logfile", NULL, NULL, N_("log filename"), N_("Specify the log filename."), VLC_FALSE );
  90     add_string_from_list( "logmode", "text", mode_list, NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT, VLC_FALSE );
  91     set_description( _("file logging interface") );
  92     set_capability( "interface", 0 );
  93     set_callbacks( Open, Close );
  94 vlc_module_end();
  95
  96 /*****************************************************************************
  97  * Open: initialize and create stuff
  98  *****************************************************************************/
  99 static int Open( vlc_object_t *p_this )
 100 {
 101     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 102     char *psz_mode, *psz_file;
 103
 104     CONSOLE_INTRO_MSG;
 105     msg_Info( p_intf, _("Using the logger interface plugin...") );
 106
 107     /* Allocate instance and initialize some members */
 108     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
 109     if( p_intf->p_sys == NULL )
 110     {
 111         msg_Err( p_intf, "out of memory" );
 112         return -1;
 113     }
 114
 115     psz_mode = config_GetPsz( p_intf, "logmode" );
 116     if( psz_mode )
 117     {
 118         if( !strcmp( psz_mode, "text" ) )
 119         {
 120             p_intf->p_sys->i_mode = MODE_TEXT;
 121         }
 122         else if( !strcmp( psz_mode, "html" ) )
 123         {
 124             p_intf->p_sys->i_mode = MODE_HTML;
 125         }
 126         else
 127         {
 128             msg_Err( p_intf, "invalid log mode `%s', using `text'", psz_mode );
 129             p_intf->p_sys->i_mode = MODE_TEXT;
 130         }
 131
 132         free( psz_mode );
 133     }
 134     else
 135     {
 136         msg_Warn( p_intf, "no log mode specified, using `text'" );
 137         p_intf->p_sys->i_mode = MODE_TEXT;
 138     }
 139
 140     psz_file = config_GetPsz( p_intf, "logfile" );
 141     if( !psz_file )
 142     {
 143         switch( p_intf->p_sys->i_mode )
 144         {
 145         case MODE_HTML:
 146             psz_file = strdup( "vlc-log.html" );
 147             break;
 148         case MODE_TEXT:
 149         default:
 150             psz_file = strdup( "vlc-log.txt" );
 151             break;
 152         }
 153
 154         msg_Warn( p_intf, "no log filename provided, using `%s'", psz_file );
 155     }
 156
 157     /* Open the log file and remove any buffering for the stream */
 158     msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
 159     p_intf->p_sys->p_file = fopen( psz_file, "wt" );
 160     if( p_intf->p_sys->p_file == NULL )
 161     {
 162         msg_Err( p_intf, "error opening logfile `%s'", psz_file );
 163         free( p_intf->p_sys );
 164         free( psz_file );
 165         return -1;
 166     }
 167     setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
 168     p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
 169
 170     free( psz_file );
 171
 172     switch( p_intf->p_sys->i_mode )
 173     {
 174     case MODE_HTML:
 175         LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
 176         break;
 177     case MODE_TEXT:
 178     default:
 179         LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
 180         break;
 181     }
 182
 183     p_intf->pf_run = Run;
 184
 185     return 0;
 186 }
 187
 188 /*****************************************************************************
 189  * Close: destroy interface stuff
 190  *****************************************************************************/
 191 static void Close( vlc_object_t *p_this )
 192 {
 193     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 194
 195     /* Flush the queue and unsubscribe from the message queue */
 196     FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
 197                 p_intf->p_sys->i_mode );
 198     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 199
 200     switch( p_intf->p_sys->i_mode )
 201     {
 202     case MODE_HTML:
 203         LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
 204         break;
 205     case MODE_TEXT:
 206     default:
 207         LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
 208         break;
 209     }
 210
 211     /* Close the log file */
 212     fclose( p_intf->p_sys->p_file );
 213
 214     /* Destroy structure */
 215     free( p_intf->p_sys );
 216 }
 217
 218 /*****************************************************************************
 219  * Run: rc thread
 220  *****************************************************************************
 221  * This part of the interface is in a separate thread so that we can call
 222  * exec() from within it without annoying the rest of the program.
 223  *****************************************************************************/
 224 static void Run( intf_thread_t *p_intf )
 225 {
 226     while( !p_intf->b_die )
 227     {
 228         FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
 229                     p_intf->p_sys->i_mode );
 230
 231         msleep( INTF_IDLE_SLEEP );
 232     }
 233 }
 234
 235 /*****************************************************************************
 236  * FlushQueue: flush the message queue into the log file
 237  *****************************************************************************/
 238 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode )
 239 {
 240     int i_start, i_stop;
 241
 242     vlc_mutex_lock( p_sub->p_lock );
 243     i_stop = *p_sub->pi_stop;
 244     vlc_mutex_unlock( p_sub->p_lock );
 245
 246     if( p_sub->i_start != i_stop )
 247     {
 248         /* Append all messages to log file */
 249         for( i_start = p_sub->i_start;
 250              i_start != i_stop;
 251              i_start = (i_start+1) % VLC_MSG_QSIZE )
 252         {
 253             switch( i_mode )
 254             {
 255             case MODE_HTML:
 256                 HtmlPrint( &p_sub->p_msg[i_start], p_file );
 257                 break;
 258             case MODE_TEXT:
 259             default:
 260                 TextPrint( &p_sub->p_msg[i_start], p_file );
 261                 break;
 262             }
 263         }
 264
 265         vlc_mutex_lock( p_sub->p_lock );
 266         p_sub->i_start = i_start;
 267         vlc_mutex_unlock( p_sub->p_lock );
 268     }
 269 }
 270
 271 static const char *ppsz_type[4] = { ": ", " error: ",
 272                                     " warning: ", " debug: " };
 273
 274 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
 275 {
 276     LOG_STRING( p_msg->psz_module, p_file );
 277     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
 278     LOG_STRING( p_msg->psz_msg, p_file );
 279     LOG_STRING( "\n", p_file );
 280 }
 281
 282 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
 283 {
 284     static const char *ppsz_color[4] = { "<font color=\"#ffffff\">",
 285                                          "<font color=\"#ff6666\">",
 286                                          "<font color=\"#ffff66\">",
 287                                          "<font color=\"#aaaaaa\">" };
 288
 289     LOG_STRING( p_msg->psz_module, p_file );
 290     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
 291     LOG_STRING( ppsz_color[p_msg->i_type], p_file );
 292     LOG_STRING( p_msg->psz_msg, p_file );
 293     LOG_STRING( "</font>\n", p_file );
 294 }
 295