git.sesse.net Git - vlc/blob - 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 #include <stdlib.h>                                      /* malloc(), free() */
  28 #include <string.h>
  29
  30 #include <errno.h>                                                 /* ENOMEM */
  31 #include <stdio.h>
  32
  33 #ifdef UNDER_CE
  34 #   define _IONBF 0x0004
  35 #endif
  36
  37 #include <vlc/vlc.h>
  38 #include <vlc/intf.h>
  39
  40 #define MODE_TEXT 0
  41 #define MODE_HTML 1
  42 #define MODE_SYSLOG 2
  43
  44 #ifdef SYS_DARWIN
  45 #define LOG_DIR "Library/Logs/"
  46 #endif
  47
  48 #define LOG_FILE_TEXT "vlc-log.txt"
  49 #define LOG_FILE_HTML "vlc-log.html"
  50
  51 #define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );
  52
  53 #define TEXT_HEADER "-- logger module started --\n"
  54 #define TEXT_FOOTER "-- logger module stopped --\n"
  55
  56 #define HTML_HEADER \
  57     "<html>\n" \
  58     "  <head>\n" \
  59     "    <title>vlc log</title>\n" \
  60     "  </head>\n" \
  61     "  <body bgcolor=\"#000000\" text=\"#aaaaaa\">\n" \
  62     "    <pre>\n" \
  63     "      <b>-- logger module started --</b>\n"
  64 #define HTML_FOOTER \
  65     "      <b>-- logger module stopped --</b>\n" \
  66     "    </pre>\n" \
  67     "  </body>\n" \
  68     "</html>\n"
  69
  70 #if HAVE_SYSLOG_H
  71 #include <syslog.h>
  72 #endif
  73
  74 /*****************************************************************************
  75  * intf_sys_t: description and status of log interface
  76  *****************************************************************************/
  77 struct intf_sys_t
  78 {
  79     int i_mode;
  80
  81     FILE *    p_file; /* The log file */
  82     msg_subscription_t *p_sub;
  83 };
  84
  85 /*****************************************************************************
  86  * Local prototypes
  87  *****************************************************************************/
  88 static int  Open    ( vlc_object_t * );
  89 static void Close   ( vlc_object_t * );
  90 static void Run     ( intf_thread_t * );
  91
  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 * );
  95 #ifdef HAVE_SYSLOG_H
  96 static void SyslogPrint       ( const msg_item_t *);
  97 #endif
  98
  99 /*****************************************************************************
 100  * Module descriptor
 101  *****************************************************************************/
 102 static char *mode_list[] = { "text", "html"
 103 #ifdef HAVE_SYSLOG_H
 104 ,"syslog"
 105 #endif
 106 };
 107 static char *mode_list_text[] = { N_("Text"), "HTML"
 108 #ifdef HAVE_SYSLOG_H
 109 , "syslog"
 110 #endif
 111 };
 112
 113 #define LOGMODE_TEXT N_("Log format")
 114 #ifdef HAVE_SYSLOG_H
 115 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are \"text\" (default), \"html\", and \"syslog\".")
 116 #else
 117 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are \"text\" (default) and \"html\".")
 118 #endif
 119
 120 vlc_module_begin();
 121     set_shortname( N_( "Logging" ) );
 122     set_description( _("File logging") );
 123
 124     add_file( "logfile", NULL, NULL,
 125              N_("Log filename"), N_("Specify the log filename."), VLC_FALSE );
 126     add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
 127                 VLC_FALSE );
 128         change_string_list( mode_list, mode_list_text, 0 );
 129
 130     set_capability( "interface", 0 );
 131     set_callbacks( Open, Close );
 132 vlc_module_end();
 133
 134 /*****************************************************************************
 135  * Open: initialize and create stuff
 136  *****************************************************************************/
 137 static int Open( vlc_object_t *p_this )
 138 {
 139     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 140     char *psz_mode, *psz_file;
 141
 142     CONSOLE_INTRO_MSG;
 143     msg_Info( p_intf, "Using logger..." );
 144
 145     /* Allocate instance and initialize some members */
 146     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
 147     if( p_intf->p_sys == NULL )
 148     {
 149         msg_Err( p_intf, "out of memory" );
 150         return -1;
 151     }
 152
 153     psz_mode = var_CreateGetString( p_intf, "logmode" );
 154     if( psz_mode )
 155     {
 156         if( !strcmp( psz_mode, "text" ) )
 157         {
 158             p_intf->p_sys->i_mode = MODE_TEXT;
 159         }
 160         else if( !strcmp( psz_mode, "html" ) )
 161         {
 162             p_intf->p_sys->i_mode = MODE_HTML;
 163         }
 164 #ifdef HAVE_SYSLOG_H
 165         else if( !strcmp( psz_mode, "syslog" ) )
 166         {
 167             p_intf->p_sys->i_mode = MODE_SYSLOG;
 168         }
 169 #endif
 170         else
 171         {
 172             msg_Err( p_intf, "invalid log mode `%s', using `text'", psz_mode );
 173             p_intf->p_sys->i_mode = MODE_TEXT;
 174         }
 175
 176         free( psz_mode );
 177     }
 178     else
 179     {
 180         msg_Warn( p_intf, "no log mode specified, using `text'" );
 181         p_intf->p_sys->i_mode = MODE_TEXT;
 182     }
 183
 184     if( p_intf->p_sys->i_mode != MODE_SYSLOG )
 185     {
 186         psz_file = config_GetPsz( p_intf, "logfile" );
 187         if( !psz_file )
 188         {
 189 #ifdef SYS_DARWIN
 190             char *psz_homedir = p_this->p_vlc->psz_homedir;
 191
 192             if( !psz_homedir )
 193             {
 194                 msg_Err( p_this, "psz_homedir is null" );
 195                 return -1;
 196             }
 197             psz_file = (char *)malloc( sizeof("/" LOG_DIR "/" LOG_FILE_HTML) +
 198                                            strlen(psz_homedir) );
 199             if( psz_file )
 200             {
 201                 switch( p_intf->p_sys->i_mode )
 202                 {
 203                 case MODE_HTML:
 204                     sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_HTML,
 205                          psz_homedir );
 206                     break;
 207                 case MODE_TEXT:
 208                 default:
 209                     sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_TEXT,
 210                          psz_homedir );
 211                     break;
 212                 }
 213             }
 214 #else
 215             switch( p_intf->p_sys->i_mode )
 216             {
 217             case MODE_HTML:
 218                 psz_file = strdup( LOG_FILE_HTML );
 219                 break;
 220             case MODE_TEXT:
 221             default:
 222                 psz_file = strdup( LOG_FILE_TEXT );
 223                 break;
 224             }
 225 #endif
 226             msg_Warn( p_intf, "no log filename provided, using `%s'",
 227                                psz_file );
 228         }
 229
 230         /* Open the log file and remove any buffering for the stream */
 231         msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
 232         p_intf->p_sys->p_file = fopen( psz_file, "wt" );
 233         if( p_intf->p_sys->p_file == NULL )
 234         {
 235             msg_Err( p_intf, "error opening logfile `%s'", psz_file );
 236             free( p_intf->p_sys );
 237             free( psz_file );
 238             return -1;
 239         }
 240         setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );
 241
 242         free( psz_file );
 243
 244         switch( p_intf->p_sys->i_mode )
 245         {
 246         case MODE_HTML:
 247             LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
 248             break;
 249         case MODE_TEXT:
 250         default:
 251             LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
 252             break;
 253         }
 254
 255     }
 256     else
 257     {
 258         p_intf->p_sys->p_file = NULL;
 259 #ifdef HAVE_SYSLOG_H
 260         openlog( "VLC", 0, LOG_DAEMON );
 261 #endif
 262     }
 263
 264     p_intf->p_sys->p_sub = msg_Subscribe( p_intf , MSG_QUEUE_NORMAL );
 265     p_intf->pf_run = Run;
 266
 267     return 0;
 268 }
 269
 270 /*****************************************************************************
 271  * Close: destroy interface stuff
 272  *****************************************************************************/
 273 static void Close( vlc_object_t *p_this )
 274 {
 275     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 276
 277     /* Flush the queue and unsubscribe from the message queue */
 278     FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
 279                 p_intf->p_sys->i_mode );
 280     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 281
 282     switch( p_intf->p_sys->i_mode )
 283     {
 284     case MODE_HTML:
 285         LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
 286         break;
 287     case MODE_TEXT:
 288 #ifdef HAVE_SYSLOG_H
 289     case MODE_SYSLOG:
 290         closelog();
 291         break;
 292 #endif
 293     default:
 294         LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
 295         break;
 296     }
 297
 298     /* Close the log file */
 299     if( p_intf->p_sys->i_mode != MODE_SYSLOG )
 300         fclose( p_intf->p_sys->p_file );
 301
 302     /* Destroy structure */
 303     free( p_intf->p_sys );
 304 }
 305
 306 /*****************************************************************************
 307  * Run: rc thread
 308  *****************************************************************************
 309  * This part of the interface is in a separate thread so that we can call
 310  * exec() from within it without annoying the rest of the program.
 311  *****************************************************************************/
 312 static void Run( intf_thread_t *p_intf )
 313 {
 314     while( !p_intf->b_die )
 315     {
 316         FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
 317                     p_intf->p_sys->i_mode );
 318
 319         msleep( INTF_IDLE_SLEEP );
 320     }
 321 }
 322
 323 /*****************************************************************************
 324  * FlushQueue: flush the message queue into the log
 325  *****************************************************************************/
 326 static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode )
 327 {
 328     int i_start, i_stop;
 329
 330     vlc_mutex_lock( p_sub->p_lock );
 331     i_stop = *p_sub->pi_stop;
 332     vlc_mutex_unlock( p_sub->p_lock );
 333
 334     if( p_sub->i_start != i_stop )
 335     {
 336         /* Append all messages to log file */
 337         for( i_start = p_sub->i_start;
 338              i_start != i_stop;
 339              i_start = (i_start+1) % VLC_MSG_QSIZE )
 340         {
 341             switch( i_mode )
 342             {
 343             case MODE_HTML:
 344                 HtmlPrint( &p_sub->p_msg[i_start], p_file );
 345                 break;
 346 #ifdef HAVE_SYSLOG_H
 347             case MODE_SYSLOG:
 348                 SyslogPrint( &p_sub->p_msg[i_start] );
 349                 break;
 350 #endif
 351             case MODE_TEXT:
 352             default:
 353                 TextPrint( &p_sub->p_msg[i_start], p_file );
 354                 break;
 355             }
 356         }
 357
 358         vlc_mutex_lock( p_sub->p_lock );
 359         p_sub->i_start = i_start;
 360         vlc_mutex_unlock( p_sub->p_lock );
 361     }
 362 }
 363
 364 static const char *ppsz_type[4] = { ": ", " error: ",
 365                                     " warning: ", " debug: " };
 366
 367 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
 368 {
 369     LOG_STRING( p_msg->psz_module, p_file );
 370     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
 371     LOG_STRING( p_msg->psz_msg, p_file );
 372     LOG_STRING( "\n", p_file );
 373 }
 374
 375 #ifdef HAVE_SYSLOG_H
 376 static void SyslogPrint( const msg_item_t *p_msg )
 377 {
 378     int i_priority = LOG_INFO;
 379
 380     if( p_msg->i_type  == 0 ) i_priority = LOG_INFO;
 381     if( p_msg->i_type  == 1 ) i_priority = LOG_ERR;
 382     if( p_msg->i_type  == 2 ) i_priority = LOG_WARNING;
 383     if( p_msg->i_type  == 3 ) i_priority = LOG_DEBUG;
 384
 385     syslog( i_priority, "%s %s", p_msg->psz_module, p_msg->psz_msg );
 386 }
 387 #endif
 388
 389 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
 390 {
 391     static const char *ppsz_color[4] = { "<font color=\"#ffffff\">",
 392                                          "<font color=\"#ff6666\">",
 393                                          "<font color=\"#ffff66\">",
 394                                          "<font color=\"#aaaaaa\">" };
 395
 396     LOG_STRING( p_msg->psz_module, p_file );
 397     LOG_STRING( ppsz_type[p_msg->i_type], p_file );
 398     LOG_STRING( ppsz_color[p_msg->i_type], p_file );
 399     LOG_STRING( p_msg->psz_msg, p_file );
 400     LOG_STRING( "</font>\n", p_file );
 401 }
 402