logger.c 14.4 KB
Newer Older
1 2 3
/*****************************************************************************
 * logger.c : file logging plugin for vlc
 *****************************************************************************
4
 * Copyright (C) 2002 the VideoLAN team
5
 * $Id$
6 7 8 9 10 11 12
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
13
 *
14 15 16 17 18 19 20
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23 24 25 26 27
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
28 29 30 31 32
#include <vlc/vlc.h>
#include <vlc_interface.h>
#include <vlc_playlist.h>
#include <vlc_charset.h>

33 34
#include <errno.h>                                                 /* ENOMEM */

35 36 37 38
#ifdef UNDER_CE
#   define _IONBF 0x0004
#endif

39 40
#define MODE_TEXT 0
#define MODE_HTML 1
41
#define MODE_SYSLOG 2
42

43
#ifdef __APPLE__
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
44 45 46 47 48 49
#define LOG_DIR "Library/Logs/"
#endif

#define LOG_FILE_TEXT "vlc-log.txt"
#define LOG_FILE_HTML "vlc-log.html"

50 51 52 53 54 55
#define LOG_STRING( msg, file ) fwrite( msg, strlen( msg ), 1, file );

#define TEXT_HEADER "-- logger module started --\n"
#define TEXT_FOOTER "-- logger module stopped --\n"

#define HTML_HEADER \
56 57
    "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n" \
    "  \"http://www.w3.org/TR/html4/strict.dtd\">\n" \
58 59 60
    "<html>\n" \
    "  <head>\n" \
    "    <title>vlc log</title>\n" \
61
    "    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" \
62
    "  </head>\n" \
63
    "  <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
64 65 66 67 68 69 70 71
    "    <pre>\n" \
    "      <b>-- logger module started --</b>\n"
#define HTML_FOOTER \
    "      <b>-- logger module stopped --</b>\n" \
    "    </pre>\n" \
    "  </body>\n" \
    "</html>\n"

72 73 74 75
#if HAVE_SYSLOG_H
#include <syslog.h>
#endif

76 77 78 79 80 81
/*****************************************************************************
 * intf_sys_t: description and status of log interface
 *****************************************************************************/
struct intf_sys_t
{
    int i_mode;
Clément Stenac's avatar
Clément Stenac committed
82 83
    FILE *p_rrd;
    mtime_t last_update;
84 85 86 87 88 89 90 91

    FILE *    p_file; /* The log file */
    msg_subscription_t *p_sub;
};

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
92
static int  Open    ( vlc_object_t * );
93 94 95 96 97 98
static void Close   ( vlc_object_t * );
static void Run     ( intf_thread_t * );

static void FlushQueue        ( msg_subscription_t *, FILE *, int );
static void TextPrint         ( const msg_item_t *, FILE * );
static void HtmlPrint         ( const msg_item_t *, FILE * );
99 100 101
#ifdef HAVE_SYSLOG_H
static void SyslogPrint       ( const msg_item_t *);
#endif
102

Clément Stenac's avatar
Clément Stenac committed
103 104
static void DoRRD( intf_thread_t *p_intf );

105 106 107
/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
108
static const char *mode_list[] = { "text", "html"
109 110 111 112
#ifdef HAVE_SYSLOG_H
,"syslog"
#endif
};
Clément Stenac's avatar
Clément Stenac committed
113
static const char *mode_list_text[] = { N_("Text"), "HTML"
114 115 116 117
#ifdef HAVE_SYSLOG_H
, "syslog"
#endif
};
118

Christophe Massiot's avatar
Christophe Massiot committed
119
#define LOGMODE_TEXT N_("Log format")
120
#ifdef HAVE_SYSLOG_H
121 122 123
#define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
  "\"text\" (default), \"html\", and \"syslog\" (special mode to send to " \
  "syslog instead of file.")
124
#else
125
#define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
Christophe Mutricy's avatar
Christophe Mutricy committed
126
  "\"text\" (default) and \"html\".")
127
#endif
Christophe Massiot's avatar
Christophe Massiot committed
128

129
vlc_module_begin();
130
    set_shortname( _( "Logging" ) );
131
    set_description( _("File logging") );
Gildas Bazin's avatar
 
Gildas Bazin committed
132

133 134 135
    set_category( CAT_ADVANCED );
    set_subcategory( SUBCAT_ADVANCED_MISC );

136 137
    add_file( "logfile", NULL, NULL,
             N_("Log filename"), N_("Specify the log filename."), VLC_FALSE );
138
        change_unsafe();
139 140 141
    add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
                VLC_FALSE );
        change_string_list( mode_list, mode_list_text, 0 );
Gildas Bazin's avatar
 
Gildas Bazin committed
142

143 144
    add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
                    N_("Output data for RRDTool in this file." ), VLC_TRUE );
Clément Stenac's avatar
Clément Stenac committed
145

146 147 148 149 150 151 152 153
    set_capability( "interface", 0 );
    set_callbacks( Open, Close );
vlc_module_end();

/*****************************************************************************
 * Open: initialize and create stuff
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
154
{
155
    intf_thread_t *p_intf = (intf_thread_t *)p_this;
Clément Stenac's avatar
Clément Stenac committed
156
    char *psz_mode, *psz_file, *psz_rrd_file;
157

Gildas Bazin's avatar
 
Gildas Bazin committed
158
    CONSOLE_INTRO_MSG;
159
    msg_Info( p_intf, "using logger..." );
160 161 162 163 164 165 166 167 168

    /* Allocate instance and initialize some members */
    p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
    if( p_intf->p_sys == NULL )
    {
        msg_Err( p_intf, "out of memory" );
        return -1;
    }

169
    psz_mode = var_CreateGetString( p_intf, "logmode" );
170 171 172 173 174 175 176 177 178 179
    if( psz_mode )
    {
        if( !strcmp( psz_mode, "text" ) )
        {
            p_intf->p_sys->i_mode = MODE_TEXT;
        }
        else if( !strcmp( psz_mode, "html" ) )
        {
            p_intf->p_sys->i_mode = MODE_HTML;
        }
180 181 182 183 184 185
#ifdef HAVE_SYSLOG_H
        else if( !strcmp( psz_mode, "syslog" ) )
        {
            p_intf->p_sys->i_mode = MODE_SYSLOG;
        }
#endif
186 187
        else
        {
188
            msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
189 190 191 192 193 194 195 196 197 198 199
            p_intf->p_sys->i_mode = MODE_TEXT;
        }

        free( psz_mode );
    }
    else
    {
        msg_Warn( p_intf, "no log mode specified, using `text'" );
        p_intf->p_sys->i_mode = MODE_TEXT;
    }

200
    if( p_intf->p_sys->i_mode != MODE_SYSLOG )
201
    {
202 203 204
        psz_file = config_GetPsz( p_intf, "logfile" );
        if( !psz_file )
        {
205
#ifdef __APPLE__
206
            char *psz_homedir = p_this->p_libvlc->psz_homedir;
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
207

208
            if( !psz_homedir ) /* XXX: This should never happen */
209
            {
210
                msg_Err( p_this, "unable to find home directory" );
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
                return -1;
            }
            psz_file = (char *)malloc( sizeof("/" LOG_DIR "/" LOG_FILE_HTML) +
                                           strlen(psz_homedir) );
            if( psz_file )
            {
                switch( p_intf->p_sys->i_mode )
                {
                case MODE_HTML:
                    sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_HTML,
                         psz_homedir );
                    break;
                case MODE_TEXT:
                default:
                    sprintf( psz_file, "%s/" LOG_DIR "/" LOG_FILE_TEXT,
                         psz_homedir );
                    break;
                }
            }
#else
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
231 232 233
            switch( p_intf->p_sys->i_mode )
            {
            case MODE_HTML:
234
                psz_file = strdup( LOG_FILE_HTML );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
235 236 237
                break;
            case MODE_TEXT:
            default:
238
                psz_file = strdup( LOG_FILE_TEXT );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
239 240
                break;
            }
241 242 243
#endif
            msg_Warn( p_intf, "no log filename provided, using `%s'",
                               psz_file );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
244
        }
245 246 247

        /* Open the log file and remove any buffering for the stream */
        msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
248
        p_intf->p_sys->p_file = utf8_fopen( psz_file, "at" );
249 250 251 252 253 254 255 256 257 258 259
        if( p_intf->p_sys->p_file == NULL )
        {
            msg_Err( p_intf, "error opening logfile `%s'", psz_file );
            free( p_intf->p_sys );
            free( psz_file );
            return -1;
        }
        setvbuf( p_intf->p_sys->p_file, NULL, _IONBF, 0 );

        free( psz_file );

260
        switch( p_intf->p_sys->i_mode )
261 262
        {
        case MODE_HTML:
263
            LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
264 265 266
            break;
        case MODE_TEXT:
        default:
267
            LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
268 269 270 271
            break;
        }

    }
272
    else
273
    {
274 275 276 277
        p_intf->p_sys->p_file = NULL;
#ifdef HAVE_SYSLOG_H
        openlog( "VLC", 0, LOG_DAEMON );
#endif
278 279
    }

Clément Stenac's avatar
Clément Stenac committed
280 281 282 283 284 285
    p_intf->p_sys->last_update = 0;
    p_intf->p_sys->p_rrd = NULL;

    psz_rrd_file = config_GetPsz( p_intf, "rrd-file" );
    if( psz_rrd_file && *psz_rrd_file )
    {
286
        p_intf->p_sys->p_rrd = utf8_fopen( psz_rrd_file, "w" );
Clément Stenac's avatar
Clément Stenac committed
287 288
    }

289
    p_intf->p_sys->p_sub = msg_Subscribe( p_intf , MSG_QUEUE_NORMAL );
Gildas Bazin's avatar
 
Gildas Bazin committed
290 291
    p_intf->pf_run = Run;

292 293 294 295 296 297 298
    return 0;
}

/*****************************************************************************
 * Close: destroy interface stuff
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
299
{
300
    intf_thread_t *p_intf = (intf_thread_t *)p_this;
301

302 303 304 305 306 307 308 309 310 311 312
    /* Flush the queue and unsubscribe from the message queue */
    FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
                p_intf->p_sys->i_mode );
    msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );

    switch( p_intf->p_sys->i_mode )
    {
    case MODE_HTML:
        LOG_STRING( HTML_FOOTER, p_intf->p_sys->p_file );
        break;
    case MODE_TEXT:
313 314 315 316 317
#ifdef HAVE_SYSLOG_H
    case MODE_SYSLOG:
        closelog();
        break;
#endif
318 319 320 321 322 323
    default:
        LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
        break;
    }

    /* Close the log file */
324 325
    if( p_intf->p_sys->i_mode != MODE_SYSLOG )
        fclose( p_intf->p_sys->p_file );
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343

    /* Destroy structure */
    free( p_intf->p_sys );
}

/*****************************************************************************
 * Run: rc thread
 *****************************************************************************
 * This part of the interface is in a separate thread so that we can call
 * exec() from within it without annoying the rest of the program.
 *****************************************************************************/
static void Run( intf_thread_t *p_intf )
{
    while( !p_intf->b_die )
    {
        FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
                    p_intf->p_sys->i_mode );

Clément Stenac's avatar
Clément Stenac committed
344 345 346
        if( p_intf->p_sys->p_rrd )
            DoRRD( p_intf );

347 348 349 350 351
        msleep( INTF_IDLE_SLEEP );
    }
}

/*****************************************************************************
352
 * FlushQueue: flush the message queue into the log
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
 *****************************************************************************/
static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode )
{
    int i_start, i_stop;

    vlc_mutex_lock( p_sub->p_lock );
    i_stop = *p_sub->pi_stop;
    vlc_mutex_unlock( p_sub->p_lock );

    if( p_sub->i_start != i_stop )
    {
        /* Append all messages to log file */
        for( i_start = p_sub->i_start;
             i_start != i_stop;
             i_start = (i_start+1) % VLC_MSG_QSIZE )
        {
            switch( i_mode )
            {
            case MODE_HTML:
                HtmlPrint( &p_sub->p_msg[i_start], p_file );
                break;
374 375 376 377 378
#ifdef HAVE_SYSLOG_H
            case MODE_SYSLOG:
                SyslogPrint( &p_sub->p_msg[i_start] );
                break;
#endif
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
            case MODE_TEXT:
            default:
                TextPrint( &p_sub->p_msg[i_start], p_file );
                break;
            }
        }

        vlc_mutex_lock( p_sub->p_lock );
        p_sub->i_start = i_start;
        vlc_mutex_unlock( p_sub->p_lock );
    }
}

static const char *ppsz_type[4] = { ": ", " error: ",
                                    " warning: ", " debug: " };

static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
{
    LOG_STRING( p_msg->psz_module, p_file );
    LOG_STRING( ppsz_type[p_msg->i_type], p_file );
    LOG_STRING( p_msg->psz_msg, p_file );
    LOG_STRING( "\n", p_file );
}

403 404 405
#ifdef HAVE_SYSLOG_H
static void SyslogPrint( const msg_item_t *p_msg )
{
406 407
    int i_priority = LOG_INFO;

408 409 410 411 412
    if( p_msg->i_type  == 0 ) i_priority = LOG_INFO;
    if( p_msg->i_type  == 1 ) i_priority = LOG_ERR;
    if( p_msg->i_type  == 2 ) i_priority = LOG_WARNING;
    if( p_msg->i_type  == 3 ) i_priority = LOG_DEBUG;

413 414 415 416 417
    if( p_msg->psz_header )
        syslog( i_priority, "%s %s: %s", p_msg->psz_header,
                p_msg->psz_module, p_msg->psz_msg );
    else
        syslog( i_priority, "%s: %s", p_msg->psz_module, p_msg->psz_msg );
418
 
419 420 421
}
#endif

422 423
static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
{
424 425 426 427
    static const char *ppsz_color[4] = { "<span style=\"color: #ffffff\">",
                                         "<span style=\"color: #ff6666\">",
                                         "<span style=\"color: #ffff66\">",
                                         "<span style=\"color: #aaaaaa\">" };
428 429 430 431 432

    LOG_STRING( p_msg->psz_module, p_file );
    LOG_STRING( ppsz_type[p_msg->i_type], p_file );
    LOG_STRING( ppsz_color[p_msg->i_type], p_file );
    LOG_STRING( p_msg->psz_msg, p_file );
433
    LOG_STRING( "</span>\n", p_file );
434 435
}

Clément Stenac's avatar
Clément Stenac committed
436 437 438 439 440 441 442 443 444 445 446
static void DoRRD( intf_thread_t *p_intf )
{
    playlist_t *p_playlist;
    if( mdate() - p_intf->p_sys->last_update < 1000000 )
        return;
    p_intf->p_sys->last_update = mdate();

    p_playlist = (playlist_t *)vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
                                                FIND_ANYWHERE );
    if( p_playlist && p_playlist->p_stats )
    {
447 448 449 450 451 452 453
        lldiv_t din = lldiv( p_playlist->p_stats->f_input_bitrate * 1000000,
                             1000 );
        lldiv_t ddm = lldiv( p_playlist->p_stats->f_demux_bitrate * 1000000,
                             1000 );
        lldiv_t dout = lldiv( p_playlist->p_stats->f_output_bitrate * 1000000,
                             1000 );
        fprintf( p_intf->p_sys->p_rrd,
454
                   I64Fi":%lld.%03u:%lld.%03u:%lld.%03u\n",
Clément Stenac's avatar
Clément Stenac committed
455
                   p_intf->p_sys->last_update/1000000,
456 457 458
                   din.quot, (unsigned int)din.rem,
                   ddm.quot, (unsigned int)ddm.rem,
                   dout.quot, (unsigned int)dout.rem );
Clément Stenac's avatar
Clément Stenac committed
459 460 461 462
        fflush( p_intf->p_sys->p_rrd );
        vlc_object_release( p_playlist );
    }
}