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 along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 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_fs.h>
  36 #include <vlc_charset.h>
  37
  38 #include <stdarg.h>
  39 #include <assert.h>
  40 #include <errno.h>
  41
  42 #ifdef __ANDROID__
  43 # include <android/log.h>
  44 #endif
  45
  46 #define LOG_FILE_TEXT "vlc-log.txt"
  47 #define LOG_FILE_HTML "vlc-log.html"
  48
  49 #define TEXT_HEADER "\xEF\xBB\xBF-- logger module started --\n"
  50 #define TEXT_FOOTER "-- logger module stopped --\n"
  51
  52 #define HTML_HEADER \
  53     "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
  54     "  \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
  55     "<html>\n" \
  56     "  <head>\n" \
  57     "    <title>vlc log</title>\n" \
  58     "    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" \
  59     "  </head>\n" \
  60     "  <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
  61     "    <pre>\n" \
  62     "      <strong>-- logger module started --</strong>\n"
  63 #define HTML_FOOTER \
  64     "      <strong>-- logger module stopped --</strong>\n" \
  65     "    </pre>\n" \
  66     "  </body>\n" \
  67     "</html>\n"
  68
  69 #ifdef HAVE_SYSLOG_H
  70 #include <syslog.h>
  71 #endif
  72
  73 /*****************************************************************************
  74  * intf_sys_t: description and status of log interface
  75  *****************************************************************************/
  76 struct intf_sys_t
  77 {
  78     FILE *p_file;
  79     const char *footer;
  80     char *ident;
  81 };
  82
  83 /*****************************************************************************
  84  * Local prototypes
  85  *****************************************************************************/
  86 static int  Open    ( vlc_object_t * );
  87 static void Close   ( vlc_object_t * );
  88
  89 static void TextPrint(void *, int, const vlc_log_t *, const char *, va_list);
  90 static void HtmlPrint(void *, int, const vlc_log_t *, const char *, va_list);
  91 #ifdef HAVE_SYSLOG_H
  92 static void SyslogPrint(void *, int, const vlc_log_t *, const char *, va_list);
  93 #endif
  94 #ifdef __ANDROID__
  95 static void AndroidPrint(void *, int, const vlc_log_t *, const char *, va_list);
  96 #endif
  97
  98 /*****************************************************************************
  99  * Module descriptor
 100  *****************************************************************************/
 101 static const char *const mode_list[] = { "text", "html"
 102 #ifdef HAVE_SYSLOG_H
 103 ,"syslog"
 104 #endif
 105 #ifdef __ANDROID__
 106 ,"android"
 107 #endif
 108 };
 109 static const char *const mode_list_text[] = { N_("Text"), "HTML"
 110 #ifdef HAVE_SYSLOG_H
 111 , "syslog"
 112 #endif
 113 #ifdef __ANDROID__
 114 ,"android"
 115 #endif
 116 };
 117
 118 #define LOGMODE_TEXT N_("Log format")
 119 #define LOGMODE_LONGTEXT N_("Specify the logging format.")
 120
 121 #ifdef HAVE_SYSLOG_H
 122 #define SYSLOG_IDENT_TEXT N_("Syslog ident")
 123 #define SYSLOG_IDENT_LONGTEXT N_("Set the ident that VLC would use when " \
 124   "logging to syslog.")
 125
 126 #define SYSLOG_FACILITY_TEXT N_("Syslog facility")
 127 #define SYSLOG_FACILITY_LONGTEXT N_("Select the syslog facility where logs " \
 128   "will be forwarded.")
 129
 130 /* First in list is the default facility used. */
 131 #define DEFINE_SYSLOG_FACILITY \
 132   DEF( "user",   LOG_USER ), \
 133   DEF( "daemon", LOG_DAEMON ), \
 134   DEF( "local0", LOG_LOCAL0 ), \
 135   DEF( "local1", LOG_LOCAL1 ), \
 136   DEF( "local2", LOG_LOCAL2 ), \
 137   DEF( "local3", LOG_LOCAL3 ), \
 138   DEF( "local4", LOG_LOCAL4 ), \
 139   DEF( "local5", LOG_LOCAL5 ), \
 140   DEF( "local6", LOG_LOCAL6 ), \
 141   DEF( "local7", LOG_LOCAL7 )
 142
 143 #define DEF( a, b ) a
 144 static const char *const fac_name[]   = { DEFINE_SYSLOG_FACILITY };
 145 #undef  DEF
 146 #define DEF( a, b ) b
 147 static const int         fac_number[] = { DEFINE_SYSLOG_FACILITY };
 148 #undef  DEF
 149 enum                   { fac_entries = sizeof(fac_name)/sizeof(fac_name[0]) };
 150 #undef  DEFINE_SYSLOG_FACILITY
 151
 152 #endif
 153
 154 #define LOGVERBOSE_TEXT N_("Verbosity")
 155 #define LOGVERBOSE_LONGTEXT N_("Select the verbosity to use for log or -1 to " \
 156 "use the same verbosity given by --verbose.")
 157
 158 vlc_module_begin ()
 159     set_shortname( N_( "Logging" ) )
 160     set_description( N_("File logging") )
 161
 162     set_category( CAT_ADVANCED )
 163     set_subcategory( SUBCAT_ADVANCED_MISC )
 164
 165     add_savefile( "logfile", NULL,
 166              N_("Log filename"), N_("Specify the log filename."), false )
 167     add_string( "logmode", "text", LOGMODE_TEXT, LOGMODE_LONGTEXT,
 168                 false )
 169         change_string_list( mode_list, mode_list_text )
 170 #ifdef HAVE_SYSLOG_H
 171     add_string( "syslog-ident", "vlc", SYSLOG_IDENT_TEXT,
 172                 SYSLOG_IDENT_LONGTEXT, true )
 173     add_string( "syslog-facility", fac_name[0], SYSLOG_FACILITY_TEXT,
 174                 SYSLOG_FACILITY_LONGTEXT, true )
 175         change_string_list( fac_name, fac_name )
 176 #endif
 177     add_integer( "log-verbose", -1, LOGVERBOSE_TEXT, LOGVERBOSE_LONGTEXT,
 178            false )
 179
 180     add_obsolete_string( "rrd-file" )
 181
 182     set_capability( "interface", 0 )
 183     set_callbacks( Open, Close )
 184 vlc_module_end ()
 185
 186 /*****************************************************************************
 187  * Open: initialize and create stuff
 188  *****************************************************************************/
 189 static int Open( vlc_object_t *p_this )
 190 {
 191     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 192     intf_sys_t *p_sys;
 193
 194     CONSOLE_INTRO_MSG;
 195     msg_Info( p_intf, "using logger." );
 196
 197     /* Allocate instance and initialize some members */
 198     p_sys = p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
 199     if( p_sys == NULL )
 200         return VLC_ENOMEM;
 201
 202     p_sys->p_file = NULL;
 203     vlc_log_cb cb = TextPrint;
 204     const char *filename = LOG_FILE_TEXT, *header = TEXT_HEADER;
 205     p_sys->footer = TEXT_FOOTER;
 206
 207     char *mode = var_InheritString( p_intf, "logmode" );
 208     if( mode != NULL )
 209     {
 210         if( !strcmp( mode, "html" ) )
 211         {
 212             p_sys->footer = HTML_FOOTER;
 213             header = HTML_HEADER;
 214             cb = HtmlPrint;
 215         }
 216 #ifdef HAVE_SYSLOG_H
 217         else if( !strcmp( mode, "syslog" ) )
 218             cb = SyslogPrint;
 219 #endif
 220 #ifdef __ANDROID__
 221         else if( !strcmp( mode, "android" ) )
 222             cb = AndroidPrint;
 223 #endif
 224         else if( strcmp( mode, "text" ) )
 225             msg_Warn( p_intf, "invalid log mode `%s', using `text'", mode );
 226         free( mode );
 227     }
 228
 229 #ifdef HAVE_SYSLOG_H
 230     if( cb == SyslogPrint )
 231     {
 232         int i_facility;
 233         char *psz_facility = var_InheritString( p_intf, "syslog-facility" );
 234         if( psz_facility )
 235         {
 236             bool b_valid = 0;
 237             for( size_t i = 0; i < fac_entries; ++i )
 238             {
 239                 if( !strcmp( psz_facility, fac_name[i] ) )
 240                 {
 241                     i_facility = fac_number[i];
 242                     b_valid = 1;
 243                     break;
 244                 }
 245             }
 246             if( !b_valid )
 247             {
 248                 msg_Warn( p_intf, "invalid syslog facility `%s', using `%s'",
 249                           psz_facility, fac_name[0] );
 250                 i_facility = fac_number[0];
 251             }
 252             free( psz_facility );
 253         }
 254         else
 255         {
 256             msg_Warn( p_intf, "no syslog facility specified, using `%s'",
 257                       fac_name[0] );
 258             i_facility = fac_number[0];
 259         }
 260
 261         char *psz_syslog_ident = var_InheritString( p_intf, "syslog-ident" );
 262         if (unlikely(psz_syslog_ident == NULL))
 263         {
 264             free( p_sys );
 265             return VLC_ENOMEM;
 266         }
 267
 268         p_sys->ident = psz_syslog_ident;
 269         openlog( p_sys->ident, LOG_PID|LOG_NDELAY, i_facility );
 270
 271         p_sys->p_file = NULL;
 272     }
 273     else
 274 #endif
 275 #ifdef __ANDROID__
 276     if( cb == AndroidPrint )
 277     {
 278         /* nothing to do */
 279     }
 280     else
 281 #endif
 282     {
 283         char *psz_file = var_InheritString( p_intf, "logfile" );
 284         if( !psz_file )
 285         {
 286 #ifdef __APPLE__
 287 # define LOG_DIR "Library/Logs"
 288             char *home = config_GetUserDir(VLC_HOME_DIR);
 289             if( home == NULL
 290              || asprintf( &psz_file, "%s/"LOG_DIR"/%s", home,
 291                           filename ) == -1 )
 292                 psz_file = NULL;
 293             free(home);
 294             filename = psz_file;
 295 #endif
 296             msg_Warn( p_intf, "no log filename provided, using `%s'",
 297                       filename );
 298         }
 299         else
 300             filename = psz_file;
 301
 302         /* Open the log file and remove any buffering for the stream */
 303         msg_Dbg( p_intf, "opening logfile `%s'", filename );
 304         p_sys->p_file = vlc_fopen( filename, "at" );
 305         if( p_sys->p_file == NULL )
 306         {
 307             msg_Err( p_intf, "error opening logfile `%s': %s", filename,
 308                      vlc_strerror_c(errno) );
 309             free( psz_file );
 310             free( p_sys );
 311             return VLC_EGENERIC;
 312         }
 313         free( psz_file );
 314         setvbuf( p_sys->p_file, NULL, _IONBF, 0 );
 315         fputs( header, p_sys->p_file );
 316     }
 317
 318     vlc_LogSet( p_intf->p_libvlc, cb, p_intf );
 319     return VLC_SUCCESS;
 320 }
 321
 322 /*****************************************************************************
 323  * Close: destroy interface stuff
 324  *****************************************************************************/
 325 static void Close( vlc_object_t *p_this )
 326 {
 327     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 328     intf_sys_t *p_sys = p_intf->p_sys;
 329
 330     /* Flush the queue and unsubscribe from the message queue */
 331     vlc_LogSet( p_intf->p_libvlc, NULL, NULL );
 332
 333     /* Close the log file */
 334 #ifdef HAVE_SYSLOG_H
 335     if( p_sys->p_file == NULL )
 336     {
 337         closelog();
 338         free( p_sys->ident );
 339     }
 340     else
 341 #endif
 342     if( p_sys->p_file )
 343     {
 344         fputs( p_sys->footer, p_sys->p_file );
 345         fclose( p_sys->p_file );
 346     }
 347
 348     /* Destroy structure */
 349     free( p_sys );
 350 }
 351
 352 static bool IgnoreMessage( intf_thread_t *p_intf, int type )
 353 {
 354     /* TODO: cache value... */
 355     int verbosity = var_InheritInteger( p_intf, "log-verbose" );
 356     if (verbosity == -1)
 357         verbosity = var_InheritInteger( p_intf, "verbose" );
 358
 359     return verbosity < 0 || verbosity < (type - VLC_MSG_ERR);
 360 }
 361
 362 /*
 363  * Logging callbacks
 364  */
 365
 366 static const char ppsz_type[4][9] = {
 367     "",
 368     " error",
 369     " warning",
 370     " debug",
 371 };
 372
 373 #ifdef __ANDROID__
 374 static const android_LogPriority prioritytype[4] = {
 375     ANDROID_LOG_INFO,
 376     ANDROID_LOG_ERROR,
 377     ANDROID_LOG_WARN,
 378     ANDROID_LOG_DEBUG
 379 };
 380
 381 static void AndroidPrint( void *opaque, int type, const vlc_log_t *item,
 382                        const char *fmt, va_list ap )
 383 {
 384     (void)item;
 385     intf_thread_t *p_intf = opaque;
 386
 387     if( IgnoreMessage( p_intf, type ) )
 388         return;
 389
 390     int canc = vlc_savecancel();
 391     __android_log_vprint(prioritytype[type], "VLC", fmt, ap);
 392     vlc_restorecancel( canc );
 393 }
 394 #endif
 395
 396 static void TextPrint( void *opaque, int type, const vlc_log_t *item,
 397                        const char *fmt, va_list ap )
 398 {
 399     intf_thread_t *p_intf = opaque;
 400     FILE *stream = p_intf->p_sys->p_file;
 401
 402     if( IgnoreMessage( p_intf, type ) )
 403         return;
 404
 405     int canc = vlc_savecancel();
 406     flockfile( stream );
 407     fprintf( stream, "%s%s: ", item->psz_module, ppsz_type[type] );
 408     vfprintf( stream, fmt, ap );
 409     putc_unlocked( '\n', stream );
 410     funlockfile( stream );
 411     vlc_restorecancel( canc );
 412 }
 413
 414 #ifdef HAVE_SYSLOG_H
 415 static void SyslogPrint( void *opaque, int type, const vlc_log_t *item,
 416                          const char *fmt, va_list ap )
 417 {
 418     static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
 419
 420     intf_thread_t *p_intf = opaque;
 421     char *str;
 422     int i_priority = i_prio[type];
 423
 424     if( IgnoreMessage( p_intf, type )
 425      || unlikely(vasprintf( &str, fmt, ap ) == -1) )
 426         return;
 427
 428     int canc = vlc_savecancel();
 429     if( item->psz_header != NULL )
 430         syslog( i_priority, "[%s] %s%s: %s", item->psz_header,
 431                 item->psz_module, ppsz_type[type], str );
 432     else
 433         syslog( i_priority, "%s%s: %s",
 434                 item->psz_module, ppsz_type[type], str );
 435     vlc_restorecancel( canc );
 436     free( str );
 437 }
 438 #endif
 439
 440 static void HtmlPrint( void *opaque, int type, const vlc_log_t *item,
 441                        const char *fmt, va_list ap )
 442 {
 443     static const unsigned color[4] = {
 444         0xffffff, 0xff6666, 0xffff66, 0xaaaaaa,
 445     };
 446
 447     intf_thread_t *p_intf = opaque;
 448     FILE *stream = p_intf->p_sys->p_file;
 449
 450     if( IgnoreMessage( p_intf, type ) )
 451         return;
 452
 453     int canc = vlc_savecancel();
 454     flockfile( stream );
 455     fprintf( stream, "%s%s: <span style=\"color: #%06x\">",
 456              item->psz_module, ppsz_type[type], color[type] );
 457     /* FIXME: encode special ASCII characters */
 458     vfprintf( stream, fmt, ap );
 459     fputs( "</span>\n", stream );
 460     funlockfile( stream );
 461     vlc_restorecancel( canc );
 462 }