logger.c 15 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
dionoea's avatar
dionoea 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

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

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

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

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

47
#ifdef __APPLE__
hartman's avatar
hartman committed
48
49
50
51
52
53
#define LOG_DIR "Library/Logs/"
#endif

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

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

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

80
81
82
83
84
85
/*****************************************************************************
 * intf_sys_t: description and status of log interface
 *****************************************************************************/
struct intf_sys_t
{
    int i_mode;
zorglub's avatar
zorglub committed
86
87
    FILE *p_rrd;
    mtime_t last_update;
88
89
90
91
92
93
94
95

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

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

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

zorglub's avatar
zorglub committed
107
108
static void DoRRD( intf_thread_t *p_intf );

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

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

133
vlc_module_begin();
134
    set_shortname( _( "Logging" ) );
135
    set_description( _("File logging") );
gbazin's avatar
   
gbazin committed
136

137
138
139
    set_category( CAT_ADVANCED );
    set_subcategory( SUBCAT_ADVANCED_MISC );

140
141
    add_file( "logfile", NULL, NULL,
             N_("Log filename"), N_("Specify the log filename."), VLC_FALSE );
142
        change_unsafe();
143
144
145
    add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
                VLC_FALSE );
        change_string_list( mode_list, mode_list_text, 0 );
gbazin's avatar
   
gbazin committed
146

147
148
    add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
                    N_("Output data for RRDTool in this file." ), VLC_TRUE );
zorglub's avatar
zorglub committed
149

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

/*****************************************************************************
 * Open: initialize and create stuff
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
158
{
159
    intf_thread_t *p_intf = (intf_thread_t *)p_this;
zorglub's avatar
zorglub committed
160
    char *psz_mode, *psz_file, *psz_rrd_file;
161

gbazin's avatar
   
gbazin committed
162
    CONSOLE_INTRO_MSG;
163
    msg_Info( p_intf, "using logger..." );
164
165
166
167
168
169
170
171
172

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

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

204
    if( p_intf->p_sys->i_mode != MODE_SYSLOG )
205
    {
206
207
208
        psz_file = config_GetPsz( p_intf, "logfile" );
        if( !psz_file )
        {
209
#ifdef __APPLE__
210
            char *psz_homedir = p_this->p_libvlc->psz_homedir;
hartman's avatar
hartman committed
211

212
            if( !psz_homedir ) /* XXX: This should never happen */
213
            {
214
                msg_Err( p_this, "unable to find home directory" );
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
                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
hartman's avatar
hartman committed
235
236
237
            switch( p_intf->p_sys->i_mode )
            {
            case MODE_HTML:
238
                psz_file = strdup( LOG_FILE_HTML );
hartman's avatar
hartman committed
239
240
241
                break;
            case MODE_TEXT:
            default:
242
                psz_file = strdup( LOG_FILE_TEXT );
hartman's avatar
hartman committed
243
244
                break;
            }
245
246
247
#endif
            msg_Warn( p_intf, "no log filename provided, using `%s'",
                               psz_file );
hartman's avatar
hartman committed
248
        }
249
250
251

        /* Open the log file and remove any buffering for the stream */
        msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
252
        p_intf->p_sys->p_file = utf8_fopen( psz_file, "at" );
253
254
255
256
257
258
259
260
261
262
263
        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 );

264
        switch( p_intf->p_sys->i_mode )
265
266
        {
        case MODE_HTML:
267
            LOG_STRING( HTML_HEADER, p_intf->p_sys->p_file );
268
269
270
            break;
        case MODE_TEXT:
        default:
271
            LOG_STRING( TEXT_HEADER, p_intf->p_sys->p_file );
272
273
274
275
            break;
        }

    }
276
    else
277
    {
278
279
        p_intf->p_sys->p_file = NULL;
#ifdef HAVE_SYSLOG_H
280
        openlog( "vlc", LOG_PID|LOG_NDELAY, LOG_DAEMON );
281
#endif
282
283
    }

zorglub's avatar
zorglub committed
284
285
286
287
288
289
    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 )
    {
290
        p_intf->p_sys->p_rrd = utf8_fopen( psz_rrd_file, "w" );
zorglub's avatar
zorglub committed
291
292
    }

293
    p_intf->p_sys->p_sub = msg_Subscribe( p_intf , MSG_QUEUE_NORMAL );
gbazin's avatar
   
gbazin committed
294
295
    p_intf->pf_run = Run;

296
297
298
299
300
301
302
    return 0;
}

/*****************************************************************************
 * Close: destroy interface stuff
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
303
{
304
    intf_thread_t *p_intf = (intf_thread_t *)p_this;
305

306
307
    /* Flush the queue and unsubscribe from the message queue */
    FlushQueue( p_intf->p_sys->p_sub, p_intf->p_sys->p_file,
308
                p_intf->p_sys->i_mode, p_intf->p_libvlc->i_verbose );
309
310
311
312
313
314
315
316
    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:
317
318
319
320
321
#ifdef HAVE_SYSLOG_H
    case MODE_SYSLOG:
        closelog();
        break;
#endif
322
323
324
325
326
327
    default:
        LOG_STRING( TEXT_FOOTER, p_intf->p_sys->p_file );
        break;
    }

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

    /* 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,
346
                    p_intf->p_sys->i_mode, p_intf->p_libvlc->i_verbose );
347

zorglub's avatar
zorglub committed
348
349
350
        if( p_intf->p_sys->p_rrd )
            DoRRD( p_intf );

351
352
353
354
355
        msleep( INTF_IDLE_SLEEP );
    }
}

/*****************************************************************************
356
 * FlushQueue: flush the message queue into the log
357
 *****************************************************************************/
358
359
static void FlushQueue( msg_subscription_t *p_sub, FILE *p_file, int i_mode,
                        int i_verbose )
360
361
362
363
364
365
366
367
368
369
370
371
372
373
{
    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 )
        {
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
            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;
            }

390
391
392
393
394
            switch( i_mode )
            {
            case MODE_HTML:
                HtmlPrint( &p_sub->p_msg[i_start], p_file );
                break;
395
396
397
398
399
#ifdef HAVE_SYSLOG_H
            case MODE_SYSLOG:
                SyslogPrint( &p_sub->p_msg[i_start] );
                break;
#endif
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
            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 );
}

424
425
426
#ifdef HAVE_SYSLOG_H
static void SyslogPrint( const msg_item_t *p_msg )
{
427
428
    static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
    int i_priority = i_prio[p_msg->i_type];
429

430
    if( p_msg->psz_header )
431
432
        syslog( i_priority, "%s%s %s: %s", p_msg->psz_header,
                ppsz_type[p_msg->i_type],
433
434
                p_msg->psz_module, p_msg->psz_msg );
    else
435
436
        syslog( i_priority, "%s%s: %s", p_msg->psz_module, 
                ppsz_type[p_msg->i_type], p_msg->psz_msg );
437
 
438
439
440
}
#endif

441
442
static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
{
443
444
445
446
    static const char *ppsz_color[4] = { "<span style=\"color: #ffffff\">",
                                         "<span style=\"color: #ff6666\">",
                                         "<span style=\"color: #ffff66\">",
                                         "<span style=\"color: #aaaaaa\">" };
447
448
449
450
451

    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 );
452
    LOG_STRING( "</span>\n", p_file );
453
454
}

zorglub's avatar
zorglub committed
455
456
457
458
459
460
461
462
463
464
465
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 )
    {
466
467
468
469
470
471
472
        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,
zorglub's avatar
zorglub committed
473
                   I64Fi":%lld.%03u:%lld.%03u:%lld.%03u\n",
zorglub's avatar
zorglub committed
474
                   p_intf->p_sys->last_update/1000000,
475
476
477
                   din.quot, (unsigned int)din.rem,
                   ddm.quot, (unsigned int)ddm.rem,
                   dout.quot, (unsigned int)dout.rem );
zorglub's avatar
zorglub committed
478
479
480
481
        fflush( p_intf->p_sys->p_rrd );
        vlc_object_release( p_playlist );
    }
}