git.sesse.net Git - vlc/blob - modules/misc/logger.c

   1 /*****************************************************************************
   2  * logger.c : file logging plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2002-2008 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
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_interface.h>
  35 #include <vlc_playlist.h>
  36 #include <vlc_charset.h>
  37
  38 #include <assert.h>
  39
  40 #ifdef UNDER_CE
  41 #   define _IONBF 0x0004
  42 #endif
  43
  44 #define MODE_TEXT 0
  45 #define MODE_HTML 1
  46 #define MODE_SYSLOG 2
  47
  48 #ifdef __APPLE__
  49 #define LOG_DIR "Library/Logs/"
  50 #endif
  51
  52 #define LOG_FILE_TEXT "vlc-log.txt"
  53 #define LOG_FILE_HTML "vlc-log.html"
  54
  55 #define TEXT_HEADER "-- logger module started --\n"
  56 #define TEXT_FOOTER "-- logger module stopped --\n"
  57
  58 #define HTML_HEADER \
  59     "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
  60     "  \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
  61     "<html>\n" \
  62     "  <head>\n" \
  63     "    <title>vlc log</title>\n" \
  64     "    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" \
  65     "  </head>\n" \
  66     "  <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
  67     "    <pre>\n" \
  68     "      <b>-- logger module started --</b>\n"
  69 #define HTML_FOOTER \
  70     "      <b>-- logger module stopped --</b>\n" \
  71     "    </pre>\n" \
  72     "  </body>\n" \
  73     "</html>\n"
  74
  75 #if HAVE_SYSLOG_H
  76 #include <syslog.h>
  77 #endif
  78
  79 struct msg_cb_data_t
  80 {
  81     intf_thread_t *p_intf;
  82     FILE *p_file;
  83     int   i_mode;
  84 };
  85
  86 /*****************************************************************************
  87  * intf_sys_t: description and status of log interface
  88  *****************************************************************************/
  89 struct intf_sys_t
  90 {
  91     msg_subscription_t *p_sub;
  92     msg_cb_data_t msg;
  93 };
  94
  95 /*****************************************************************************
  96  * Local prototypes
  97  *****************************************************************************/
  98 static int  Open    ( vlc_object_t * );
  99 static void Close   ( vlc_object_t * );
 100
 101 static void Overflow (msg_cb_data_t *p_sys, msg_item_t *p_item, unsigned overruns);
 102 static void TextPrint         ( const msg_item_t *, FILE * );
 103 static void HtmlPrint         ( const msg_item_t *, FILE * );
 104 #ifdef HAVE_SYSLOG_H
 105 static void SyslogPrint       ( const msg_item_t *);
 106 #endif
 107
 108 /*****************************************************************************
 109  * Module descriptor
 110  *****************************************************************************/
 111 static const char *const mode_list[] = { "text", "html"
 112 #ifdef HAVE_SYSLOG_H
 113 ,"syslog"
 114 #endif
 115 };
 116 static const char *const mode_list_text[] = { N_("Text"), "HTML"
 117 #ifdef HAVE_SYSLOG_H
 118 , "syslog"
 119 #endif
 120 };
 121
 122 #define LOGMODE_TEXT N_("Log format")
 123 #ifdef HAVE_SYSLOG_H
 124 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
 125   "\"text\" (default), \"html\", and \"syslog\" (special mode to send to " \
 126   "syslog instead of file.")
 127 #else
 128 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
 129   "\"text\" (default) and \"html\".")
 130 #endif
 131
 132 #ifdef HAVE_SYSLOG_H
 133 static const char *const facility_list[] = { "daemon", "user", "local0",
 134     "local1", "local2", "local3", "local4", "local5", "local6", "local7" };
 135
 136 #define SYSLOG_FACILITY_TEXT N_("Syslog facility")
 137 #define SYSLOG_FACILITY_LONGTEXT N_("Select the syslog facility where logs " \
 138   "will be forwarded. Available choices are \"daemon\" (default), \"user\", " \
 139   "and \"local0\" through \"local7\".")
 140 #endif
 141
 142 vlc_module_begin ()
 143     set_shortname( N_( "Logging" ) )
 144     set_description( N_("File logging") )
 145
 146     set_category( CAT_ADVANCED )
 147     set_subcategory( SUBCAT_ADVANCED_MISC )
 148
 149     add_file( "logfile", NULL, NULL,
 150              N_("Log filename"), N_("Specify the log filename."), false )
 151     add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
 152                 false )
 153         change_string_list( mode_list, mode_list_text, 0 )
 154 #ifdef HAVE_SYSLOG_H
 155     add_string( "syslog-facility", "daemon", NULL, SYSLOG_FACILITY_TEXT,
 156                 SYSLOG_FACILITY_LONGTEXT, true )
 157         change_string_list( facility_list, facility_list, 0 )
 158 #endif
 159
 160     add_obsolete_string( "rrd-file" )
 161
 162     set_capability( "interface", 0 )
 163     set_callbacks( Open, Close )
 164 vlc_module_end ()
 165
 166 /*****************************************************************************
 167  * Open: initialize and create stuff
 168  *****************************************************************************/
 169 static int Open( vlc_object_t *p_this )
 170 {
 171     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 172     intf_sys_t *p_sys;
 173     char *psz_mode;
 174
 175     CONSOLE_INTRO_MSG;
 176     msg_Info( p_intf, "using logger..." );
 177
 178     /* Allocate instance and initialize some members */
 179     p_sys = p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
 180     if( p_sys == NULL )
 181         return VLC_ENOMEM;
 182
 183     p_sys->msg.p_intf = p_intf;
 184     p_sys->msg.i_mode = MODE_TEXT;
 185     psz_mode = var_CreateGetString( p_intf, "logmode" );
 186     if( psz_mode )
 187     {
 188         if( !strcmp( psz_mode, "text" ) )
 189             ;
 190         else if( !strcmp( psz_mode, "html" ) )
 191         {
 192             p_sys->msg.i_mode = MODE_HTML;
 193         }
 194 #ifdef HAVE_SYSLOG_H
 195         else if( !strcmp( psz_mode, "syslog" ) )
 196         {
 197             p_sys->msg.i_mode = MODE_SYSLOG;
 198         }
 199 #endif
 200         else
 201         {
 202             msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
 203             p_sys->msg.i_mode = MODE_TEXT;
 204         }
 205         free( psz_mode );
 206     }
 207     else
 208     {
 209         msg_Warn( p_intf, "no log mode specified, using `text'" );
 210     }
 211
 212     if( p_sys->msg.i_mode != MODE_SYSLOG )
 213     {
 214         char *psz_file = config_GetPsz( p_intf, "logfile" );
 215         if( !psz_file )
 216         {
 217 #ifdef __APPLE__
 218             if( asprintf( &psz_file, "%s/"LOG_DIR"/%s", config_GetHomeDir(),
 219                 (p_sys->msg.i_mode == MODE_HTML) ? LOG_FILE_HTML
 220                                              : LOG_FILE_TEXT ) == -1 )
 221                 psz_file = NULL;
 222 #else
 223             switch( p_sys->msg.i_mode )
 224             {
 225             case MODE_HTML:
 226                 psz_file = strdup( LOG_FILE_HTML );
 227                 break;
 228             case MODE_TEXT:
 229             default:
 230                 psz_file = strdup( LOG_FILE_TEXT );
 231                 break;
 232             }
 233 #endif
 234             msg_Warn( p_intf, "no log filename provided, using `%s'",
 235                                psz_file );
 236         }
 237
 238         /* Open the log file and remove any buffering for the stream */
 239         msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
 240         p_sys->msg.p_file = utf8_fopen( psz_file, "at" );
 241         if( p_sys->msg.p_file == NULL )
 242         {
 243             msg_Err( p_intf, "error opening logfile `%s'", psz_file );
 244             free( p_sys );
 245             free( psz_file );
 246             return -1;
 247         }
 248         setvbuf( p_sys->msg.p_file, NULL, _IONBF, 0 );
 249
 250         free( psz_file );
 251
 252         switch( p_sys->msg.i_mode )
 253         {
 254         case MODE_HTML:
 255             fputs( HTML_HEADER, p_sys->msg.p_file );
 256             break;
 257         case MODE_TEXT:
 258         default:
 259             fputs( TEXT_HEADER, p_sys->msg.p_file );
 260             break;
 261         }
 262
 263     }
 264     else
 265     {
 266         p_sys->msg.p_file = NULL;
 267 #ifdef HAVE_SYSLOG_H
 268         int i_facility = LOG_DAEMON;
 269         char *psz_facility = var_CreateGetString( p_intf, "syslog-facility" );
 270         if( psz_facility )
 271         {
 272             bool b_valid = 0;
 273             static const struct { const char psz_name[7]; int i_value; }
 274             p_facility[10] = {
 275                 { "daemon", LOG_DAEMON }, { "user", LOG_USER },
 276                 { "local0", LOG_LOCAL0 }, { "local1", LOG_LOCAL1 },
 277                 { "local2", LOG_LOCAL2 }, { "local3", LOG_LOCAL3 },
 278                 { "local4", LOG_LOCAL4 }, { "local5", LOG_LOCAL5 },
 279                 { "local6", LOG_LOCAL6 }, { "local7", LOG_LOCAL7 }
 280             };
 281             for( size_t i = 0;
 282                  i < sizeof( p_facility ) / sizeof( p_facility[0] );
 283                  i++ )
 284             {
 285                 if( !strcmp( psz_facility, p_facility[i].psz_name ) )
 286                 {
 287                     i_facility = p_facility[i].i_value;
 288                     b_valid = 1;
 289                     break;
 290                 }
 291             }
 292             if( !b_valid )
 293             {
 294                 msg_Warn( p_intf, "invalid syslog facility `%s', using `daemon'", psz_facility );
 295             }
 296             free( psz_facility );
 297         }
 298         else
 299         {
 300             msg_Warn( p_intf, "no syslog facility specified, using `daemon'" );
 301         }
 302
 303         openlog( "vlc", LOG_PID|LOG_NDELAY, i_facility );
 304 #endif
 305     }
 306
 307     p_sys->p_sub = msg_Subscribe( p_intf->p_libvlc, Overflow, &p_sys->msg );
 308
 309     return 0;
 310 }
 311
 312 /*****************************************************************************
 313  * Close: destroy interface stuff
 314  *****************************************************************************/
 315 static void Close( vlc_object_t *p_this )
 316 {
 317     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 318     intf_sys_t *p_sys = p_intf->p_sys;
 319
 320     /* Flush the queue and unsubscribe from the message queue */
 321     /* FIXME: flush */
 322     msg_Unsubscribe( p_sys->p_sub );
 323
 324     switch( p_sys->msg.i_mode )
 325     {
 326     case MODE_HTML:
 327         fputs( HTML_FOOTER, p_sys->msg.p_file );
 328         break;
 329 #ifdef HAVE_SYSLOG_H
 330     case MODE_SYSLOG:
 331         closelog();
 332         break;
 333 #endif
 334     case MODE_TEXT:
 335     default:
 336         fputs( TEXT_FOOTER, p_sys->msg.p_file );
 337         break;
 338     }
 339
 340     /* Close the log file */
 341     if( p_sys->msg.p_file )
 342         fclose( p_sys->msg.p_file );
 343
 344     /* Destroy structure */
 345     free( p_sys );
 346 }
 347
 348 /**
 349  * Log a message
 350  */
 351 static void Overflow (msg_cb_data_t *p_sys, msg_item_t *p_item, unsigned overruns)
 352 {
 353     int verbosity = var_CreateGetInteger( p_sys->p_intf, "verbose" );
 354     int priority = 0;
 355
 356     switch( p_item->i_type )
 357     {
 358         case VLC_MSG_WARN: priority = 1; break;
 359         case VLC_MSG_DBG:  priority = 2; break;
 360     }
 361     if (verbosity < priority)
 362         return;
 363
 364     switch( p_sys->i_mode )
 365     {
 366         case MODE_HTML:
 367             HtmlPrint( p_item, p_sys->p_file );
 368             break;
 369 #ifdef HAVE_SYSLOG_H
 370         case MODE_SYSLOG:
 371             SyslogPrint( p_item );
 372             break;
 373 #endif
 374         case MODE_TEXT:
 375         default:
 376             TextPrint( p_item, p_sys->p_file );
 377             break;
 378     }
 379 }
 380
 381 static const char ppsz_type[4][11] = {
 382     ": ",
 383     " error: ",
 384     " warning: ",
 385     " debug: ",
 386 };
 387
 388 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
 389 {
 390     fprintf( p_file, "%s%s%s\n", p_msg->psz_module, ppsz_type[p_msg->i_type],
 391              p_msg->psz_msg );
 392 }
 393
 394 #ifdef HAVE_SYSLOG_H
 395 static void SyslogPrint( const msg_item_t *p_msg )
 396 {
 397     static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
 398     int i_priority = i_prio[p_msg->i_type];
 399
 400     if( p_msg->psz_header )
 401         syslog( i_priority, "%s %s%s%s", p_msg->psz_header, p_msg->psz_module,
 402                 ppsz_type[p_msg->i_type], p_msg->psz_msg );
 403     else
 404         syslog( i_priority, "%s%s%s", p_msg->psz_module,
 405                 ppsz_type[p_msg->i_type], p_msg->psz_msg );
 406
 407 }
 408 #endif
 409
 410 static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
 411 {
 412     static const char ppsz_color[4][30] = {
 413         "<span style=\"color: #ffffff\">",
 414         "<span style=\"color: #ff6666\">",
 415         "<span style=\"color: #ffff66\">",
 416         "<span style=\"color: #aaaaaa\">",
 417     };
 418
 419     fprintf( p_file, "%s%s%s%s</span>\n", p_msg->psz_module,
 420              ppsz_type[p_msg->i_type], ppsz_color[p_msg->i_type],
 421              p_msg->psz_msg );
 422 }