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
 *****************************************************************************/

28 29 30 31
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

32
#include <vlc_common.h>
33
#include <vlc_plugin.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
34 35 36 37
#include <vlc_interface.h>
#include <vlc_playlist.h>
#include <vlc_charset.h>

38 39
#include <errno.h>                                                 /* ENOMEM */

40 41 42 43
#ifdef UNDER_CE
#   define _IONBF 0x0004
#endif

44 45
#define MODE_TEXT 0
#define MODE_HTML 1
46
#define MODE_SYSLOG 2
47

48
#ifdef __APPLE__
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
49 50 51 52 53 54
#define LOG_DIR "Library/Logs/"
#endif

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

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

77 78 79 80
#if HAVE_SYSLOG_H
#include <syslog.h>
#endif

81 82 83 84 85 86
/*****************************************************************************
 * 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
87 88
    FILE *p_rrd;
    mtime_t last_update;
89
    time_t now;  /* timestamp for rrd-log */
90 91 92 93 94 95 96 97

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

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
98
static int  Open    ( vlc_object_t * );
99 100 101
static void Close   ( vlc_object_t * );
static void Run     ( intf_thread_t * );

102
static void FlushQueue        ( msg_subscription_t *, FILE *, int, int );
103 104
static void TextPrint         ( const msg_item_t *, FILE * );
static void HtmlPrint         ( const msg_item_t *, FILE * );
105 106 107
#ifdef HAVE_SYSLOG_H
static void SyslogPrint       ( const msg_item_t *);
#endif
108

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

111 112 113
/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
114
static const char *const mode_list[] = { "text", "html"
115 116 117 118
#ifdef HAVE_SYSLOG_H
,"syslog"
#endif
};
119
static const char *const mode_list_text[] = { N_("Text"), "HTML"
120 121 122 123
#ifdef HAVE_SYSLOG_H
, "syslog"
#endif
};
124

Christophe Massiot's avatar
Christophe Massiot committed
125
#define LOGMODE_TEXT N_("Log format")
126
#ifdef HAVE_SYSLOG_H
127 128 129
#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.")
130
#else
131
#define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
Christophe Mutricy's avatar
Christophe Mutricy committed
132
  "\"text\" (default) and \"html\".")
133
#endif
Christophe Massiot's avatar
Christophe Massiot committed
134

135
vlc_module_begin();
136 137
    set_shortname( N_( "Logging" ) );
    set_description( N_("File logging") );
Gildas Bazin's avatar
 
Gildas Bazin committed
138

139 140 141
    set_category( CAT_ADVANCED );
    set_subcategory( SUBCAT_ADVANCED_MISC );

142
    add_file( "logfile", NULL, NULL,
143
             N_("Log filename"), N_("Specify the log filename."), false );
144
        change_unsafe();
145
    add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
146
                false );
147
        change_string_list( mode_list, mode_list_text, 0 );
Gildas Bazin's avatar
 
Gildas Bazin committed
148

149
    add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
150
                    N_("Output data for RRDTool in this file." ), true );
Clément Stenac's avatar
Clément Stenac committed
151

152 153 154 155 156 157 158 159
    set_capability( "interface", 0 );
    set_callbacks( Open, Close );
vlc_module_end();

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

Gildas Bazin's avatar
 
Gildas Bazin committed
164
    CONSOLE_INTRO_MSG;
165
    msg_Info( p_intf, "using logger..." );
166 167 168 169 170 171

    /* Allocate instance and initialize some members */
    p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
    if( p_intf->p_sys == NULL )
        return -1;

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

203
    if( p_intf->p_sys->i_mode != MODE_SYSLOG )
204
    {
205 206 207
        psz_file = config_GetPsz( p_intf, "logfile" );
        if( !psz_file )
        {
208
#ifdef __APPLE__
209 210 211 212
            if( asprintf( &psz_file, "%s/"LOG_DIR"/%s", config_GetHomeDir(),
                (p_intf->p_sys->i_mode == MODE_HTML) ? LOG_FILE_HTML
                                                     : LOG_FILE_TEXT ) == -1 )
                psz_file = NULL;
213
#else
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
214 215 216
            switch( p_intf->p_sys->i_mode )
            {
            case MODE_HTML:
217
                psz_file = strdup( LOG_FILE_HTML );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
218 219 220
                break;
            case MODE_TEXT:
            default:
221
                psz_file = strdup( LOG_FILE_TEXT );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
222 223
                break;
            }
224 225 226
#endif
            msg_Warn( p_intf, "no log filename provided, using `%s'",
                               psz_file );
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
227
        }
228 229 230

        /* Open the log file and remove any buffering for the stream */
        msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
231
        p_intf->p_sys->p_file = utf8_fopen( psz_file, "at" );
232 233 234 235 236 237 238 239 240 241 242
        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 );

243
        switch( p_intf->p_sys->i_mode )
244 245
        {
        case MODE_HTML:
246
            LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
247 248 249
            break;
        case MODE_TEXT:
        default:
250
            LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
251 252 253 254
            break;
        }

    }
255
    else
256
    {
257 258
        p_intf->p_sys->p_file = NULL;
#ifdef HAVE_SYSLOG_H
259
        openlog( "vlc", LOG_PID|LOG_NDELAY, LOG_DAEMON );
260
#endif
261 262
    }

Clément Stenac's avatar
Clément Stenac committed
263 264 265 266 267 268
    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 )
    {
269
        p_intf->p_sys->p_rrd = utf8_fopen( psz_rrd_file, "w" );
Clément Stenac's avatar
Clément Stenac committed
270
    }
Rémi Duraffort's avatar
Rémi Duraffort committed
271
    free( psz_rrd_file );
Clément Stenac's avatar
Clément Stenac committed
272

273
    p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
Gildas Bazin's avatar
 
Gildas Bazin committed
274 275
    p_intf->pf_run = Run;

276 277 278 279 280 281 282
    return 0;
}

/*****************************************************************************
 * Close: destroy interface stuff
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
283
{
284
    intf_thread_t *p_intf = (intf_thread_t *)p_this;
285

286 287
    /* Flush the queue and unsubscribe from the message queue */
    FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
288 289
                p_intf->p_sys->i_mode,
                var_CreateGetInteger( p_intf, "verbose" ) );
290 291 292 293 294 295 296 297
    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:
298 299 300 301 302
#ifdef HAVE_SYSLOG_H
    case MODE_SYSLOG:
        closelog();
        break;
#endif
303 304 305 306 307 308
    default:
        LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
        break;
    }

    /* Close the log file */
309 310
    if( p_intf->p_sys->i_mode != MODE_SYSLOG )
        fclose( p_intf->p_sys->p_file );
311 312 313 314 315 316 317 318 319 320 321 322 323

    /* 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 )
{
324
    for( ;; )
325
    {
326
        int canc = vlc_savecancel();
327
        FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
328 329
                    p_intf->p_sys->i_mode,
                    var_CreateGetInteger( p_intf, "verbose" ) );
Clément Stenac's avatar
Clément Stenac committed
330 331 332
        if( p_intf->p_sys->p_rrd )
            DoRRD( p_intf );

333 334
        vlc_restorecancel( canc );
        /* FIXME: this is WRONG. */
335 336 337 338 339
        msleep( INTF_IDLE_SLEEP );
    }
}

/*****************************************************************************
340
 * FlushQueue: flush the message queue into the log
341
 *****************************************************************************/
342 343
static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode,
                        int i_verbose )
344 345 346 347 348 349 350 351 352 353 354 355 356 357
{
    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 )
        {
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
            switch( p_sub->p_msg[i_start].i_type )
            {
            case VLC_MSG_ERR:
                if( i_verbose < 0 ) continue;
                break;
            case VLC_MSG_INFO:
                if( i_verbose < 0 ) continue;
                break;
            case VLC_MSG_WARN:
                if( i_verbose < 1 ) continue;
                break;
            case VLC_MSG_DBG:
                if( i_verbose < 2 ) continue;
                break;
            }

374 375 376 377 378
            switch( i_mode )
            {
            case MODE_HTML:
                HtmlPrint( &p_sub->p_msg[i_start], p_file );
                break;
379 380 381 382 383
#ifdef HAVE_SYSLOG_H
            case MODE_SYSLOG:
                SyslogPrint( &p_sub->p_msg[i_start] );
                break;
#endif
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
            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 );
}

408 409 410
#ifdef HAVE_SYSLOG_H
static void SyslogPrint( const msg_item_t *p_msg )
{
411 412
    static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
    int i_priority = i_prio[p_msg->i_type];
413

414
    if( p_msg->psz_header )
415 416
        syslog( i_priority, "%s%s %s: %s", p_msg->psz_header,
                ppsz_type[p_msg->i_type],
417 418
                p_msg->psz_module, p_msg->psz_msg );
    else
419 420
        syslog( i_priority, "%s%s: %s", p_msg->psz_module, 
                ppsz_type[p_msg->i_type], p_msg->psz_msg );
421
 
422 423 424
}
#endif

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

    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 );
436
    LOG_STRING( "</span>\n", p_file );
437 438
}

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

446
    if( p_intf->p_libvlc->p_stats )
Clément Stenac's avatar
Clément Stenac committed
447
    {
448
        time(&p_intf->p_sys->now);
449
        lldiv_t din = lldiv( p_intf->p_libvlc->p_stats->f_input_bitrate * 1000000,
450
                             1000 );
451
        lldiv_t ddm = lldiv( p_intf->p_libvlc->p_stats->f_demux_bitrate * 1000000,
452
                             1000 );
453
        lldiv_t dout = lldiv( p_intf->p_libvlc->p_stats->f_output_bitrate * 1000000,
454 455
                             1000 );
        fprintf( p_intf->p_sys->p_rrd,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
456
                   "%"PRIi64":%lld.%03u:%lld.%03u:%lld.%03u\n",
457
                   (uintmax_t)p_intf->p_sys->now,
458 459 460
                   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
461 462 463
        fflush( p_intf->p_sys->p_rrd );
    }
}