messages.c 9.97 KB
Newer Older
1
/*****************************************************************************
2
3
 * messages.c: messages interface
 * This library provides an interface to the message queue to be used by other
4
 * modules, especially intf modules. See vlc_config.h for output configuration.
5
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL    
Jean-Baptiste Kempf committed
6
 * Copyright (C) 1998-2005 VLC authors and VideoLAN
zorglub's avatar
zorglub committed
7
 * $Id$
8
 *
Sam Hocevar's avatar
   
Sam Hocevar committed
9
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10
 *          Samuel Hocevar <sam@zoy.org>
11
 *
Jean-Baptiste Kempf's avatar
LGPL    
Jean-Baptiste Kempf committed
12
13
14
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
15
 * (at your option) any later version.
16
 *
17
18
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL    
Jean-Baptiste Kempf committed
19
20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
21
 *
Jean-Baptiste Kempf's avatar
LGPL    
Jean-Baptiste Kempf committed
22
23
24
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
26

27
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
28
 * Preamble
29
 *****************************************************************************/
30

31
32
33
34
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

35
#include <stdlib.h>
36
#include <stdarg.h>                                       /* va_list for BSD */
37
#ifdef __APPLE__
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
38
# include <xlocale.h>
39
#elif defined(HAVE_LOCALE_H)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
40
# include <locale.h>
41
#endif
42
#include <errno.h>                                                  /* errno */
43
#include <assert.h>
44
#include <unistd.h>
45

46
47
#include <vlc_common.h>
#include <vlc_interface.h>
48
#ifdef _WIN32
49
50
#   include <vlc_network.h>          /* 'net_strerror' and 'WSAGetLastError' */
#endif
zorglub's avatar
zorglub committed
51
#include <vlc_charset.h>
52
#include "../libvlc.h"
53

54
55
/**
 * Emit a log message.
56
 * \param obj VLC object emitting the message or NULL
57
58
59
60
61
62
63
 * \param type VLC_MSG_* message type (info, error, warning or debug)
 * \param module name of module from which the message come
 *               (normally MODULE_STRING)
 * \param format printf-like message format
 */
void vlc_Log (vlc_object_t *obj, int type, const char *module,
              const char *format, ... )
Michel Kaempf's avatar
Michel Kaempf committed
64
{
65
    va_list args;
Michel Kaempf's avatar
Michel Kaempf committed
66

67
68
69
    va_start (args, format);
    vlc_vaLog (obj, type, module, format, args);
    va_end (args);
Michel Kaempf's avatar
Michel Kaempf committed
70
}
71

72
#ifdef _WIN32
73
static void Win32DebugOutputMsg (void *, int , const vlc_log_t *,
74
75
                                 const char *, va_list);
#endif
76

sigmunau's avatar
all:    
sigmunau committed
77
/**
78
79
 * Emit a log message. This function is the variable argument list equivalent
 * to vlc_Log().
sigmunau's avatar
all:    
sigmunau committed
80
 */
81
82
void vlc_vaLog (vlc_object_t *obj, int type, const char *module,
                const char *format, va_list args)
Michel Kaempf's avatar
Michel Kaempf committed
83
{
84
    if (obj != NULL && obj->i_flags & OBJECT_FLAGS_QUIET)
85
        return;
86

87
88
89
    /* C locale to get error messages in English in the logs */
    locale_t c = newlocale (LC_MESSAGES_MASK, "C", (locale_t)0);
    locale_t locale = uselocale (c);
90

91
92
#ifndef __GLIBC__
    /* Expand %m to strerror(errno) - only once */
93
94
    char buf[strlen(format) + 2001], *ptr;
    strcpy (buf, format);
Rafaël Carré's avatar
Rafaël Carré committed
95
    ptr = (char*)buf;
96
    format = (const char*) buf;
97
98
99
100
101
102
103
104
105
106
107
108

    for( ;; )
    {
        ptr = strchr( ptr, '%' );
        if( ptr == NULL )
            break;

        if( ptr[1] == 'm' )
        {
            char errbuf[2001];
            size_t errlen;

109
#ifndef _WIN32
110
            strerror_r( errno, errbuf, 1001 );
111
112
113
114
115
116
117
#else
            int sockerr = WSAGetLastError( );
            if( sockerr )
            {
                strncpy( errbuf, net_strerror( sockerr ), 1001 );
                WSASetLastError( sockerr );
            }
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
118
119
            if ((sockerr == 0)
             || (strcmp ("Unknown network stack error", errbuf) == 0))
120
121
                strncpy( errbuf, strerror( errno ), 1001 );
#endif
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
            errbuf[1000] = 0;

            /* Escape '%' from the error string */
            for( char *percent = strchr( errbuf, '%' );
                 percent != NULL;
                 percent = strchr( percent + 2, '%' ) )
            {
                memmove( percent + 1, percent, strlen( percent ) + 1 );
            }

            errlen = strlen( errbuf );
            memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
            memcpy( ptr, errbuf, errlen );
            break; /* Only once, so we don't overflow */
        }

        /* Looks for conversion specifier... */
        do
            ptr++;
        while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
        if( *ptr )
            ptr++; /* ...and skip it */
    }
#endif

147
    /* Fill message information fields */
148
    vlc_log_t msg;
149

150
    msg.i_object_id = (uintptr_t)obj;
151
    msg.psz_object_type = (obj != NULL) ? obj->psz_object_type : "generic";
152
    msg.psz_module = module;
153
    msg.psz_header = NULL;
154

155
    for (vlc_object_t *o = obj; o != NULL; o = o->p_parent)
156
        if (o->psz_header != NULL)
157
        {
158
            msg.psz_header = o->psz_header;
159
            break;
160
        }
161

162
    /* Pass message to the callback */
163
    libvlc_priv_t *priv = obj ? libvlc_priv (obj->p_libvlc) : NULL;
164

165
#ifdef _WIN32
166
167
    va_list ap;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
168
    va_copy (ap, args);
169
    Win32DebugOutputMsg (priv ? &priv->log.verbose : NULL, type, &msg, format, ap);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
170
    va_end (ap);
171
172
#endif

173
174
175
176
177
    if (priv) {
        vlc_rwlock_rdlock (&priv->log.lock);
        priv->log.cb (priv->log.opaque, type, &msg, format, args);
        vlc_rwlock_unlock (&priv->log.lock);
    }
178

179
180
    uselocale (locale);
    freelocale (c);
Michel Kaempf's avatar
Michel Kaempf committed
181
182
}

183
184
185
186
187
188
189
190
191
static const char msg_type[4][9] = { "", " error", " warning", " debug" };
#define COL(x,y)  "\033[" #x ";" #y "m"
#define RED     COL(31,1)
#define GREEN   COL(32,1)
#define YELLOW  COL(0,33)
#define WHITE   COL(0,1)
#define GRAY    "\033[0m"
static const char msg_color[4][8] = { WHITE, RED, YELLOW, GRAY };

192
static void PrintColorMsg (void *d, int type, const vlc_log_t *p_item,
193
                           const char *format, va_list ap)
194
{
195
    FILE *stream = stderr;
196
    int verbose = (intptr_t)d;
197

198
    if (verbose < 0 || verbose < (type - VLC_MSG_ERR))
199
        return;
200

201
202
203
204
205
206
    int canc = vlc_savecancel ();

    flockfile (stream);
    fprintf (stream, "["GREEN"%p"GRAY"] ", (void *)p_item->i_object_id);
    if (p_item->psz_header != NULL)
        utf8_fprintf (stream, "[%s] ", p_item->psz_header);
207
208
209
210
    utf8_fprintf (stream, "%s %s%s: %s", p_item->psz_module,
                  p_item->psz_object_type, msg_type[type], msg_color[type]);
    utf8_vfprintf (stream, format, ap);
    fputs (GRAY"\n", stream);
211
#if defined (_WIN32) || defined (__OS2__)
212
213
214
215
216
217
    fflush (stream);
#endif
    funlockfile (stream);
    vlc_restorecancel (canc);
}

218
static void PrintMsg (void *d, int type, const vlc_log_t *p_item,
219
                      const char *format, va_list ap)
220
{
221
    FILE *stream = stderr;
222
    int verbose = (intptr_t)d;
223

224
    if (verbose < 0 || verbose < (type - VLC_MSG_ERR))
225
226
        return;

227
228
229
    int canc = vlc_savecancel ();

    flockfile (stream);
230
    fprintf (stream, "[%p] ", (void *)p_item->i_object_id);
231
    if (p_item->psz_header != NULL)
232
        utf8_fprintf (stream, "[%s] ", p_item->psz_header);
233
234
235
    utf8_fprintf (stream, "%s %s%s: ", p_item->psz_module,
                  p_item->psz_object_type, msg_type[type]);
    utf8_vfprintf (stream, format, ap);
236
    putc_unlocked ('\n', stream);
237
#if defined (_WIN32) || defined (__OS2__)
238
    fflush (stream);
239
#endif
240
    funlockfile (stream);
241
    vlc_restorecancel (canc);
242
}
243

244
#ifdef _WIN32
245
static void Win32DebugOutputMsg (void* d, int type, const vlc_log_t *p_item,
246
247
                                 const char *format, va_list dol)
{
248
249
    VLC_UNUSED(p_item);

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
    const signed char *pverbose = d;
    if (pverbose && (*pverbose < 0 || *pverbose < (type - VLC_MSG_ERR)))
        return;

    va_list dol2;
    va_copy (dol2, dol);
    int msg_len = vsnprintf(NULL, 0, format, dol2);
    va_end (dol2);

    if(msg_len <= 0)
        return;

    char *msg = malloc(msg_len + 1 + 1);
    if (!msg)
        return;

    msg_len = vsnprintf(msg, msg_len+1, format, dol);
    if (msg_len > 0){
        if(msg[msg_len-1] != '\n'){
            msg[msg_len] = '\n';
            msg[msg_len + 1] = '\0';
        }
272
273
274
275
276
277
278
279
        char* psz_msg = NULL;
        if(asprintf(&psz_msg, "%s %s%s: %s", p_item->psz_module,
                    p_item->psz_object_type, msg_type[type], msg) > 0) {
            wchar_t* wmsg = ToWide(psz_msg);
            OutputDebugStringW(wmsg);
            free(wmsg);
            free(psz_msg);
        }
280
281
282
283
    }
    free(msg);
}
#endif
284
285
286
287
288
289
290
291
292
293
294
295

/**
 * Sets the message logging callback.
 * \param cb message callback, or NULL to reset
 * \param data data pointer for the message callback
 */
void vlc_LogSet (libvlc_int_t *vlc, vlc_log_cb cb, void *opaque)
{
    libvlc_priv_t *priv = libvlc_priv (vlc);

    if (cb == NULL)
    {
296
#if defined (HAVE_ISATTY) && !defined (_WIN32)
297
298
299
300
301
302
        if (isatty (STDERR_FILENO) && var_InheritBool (vlc, "color"))
            cb = PrintColorMsg;
        else
#endif
            cb = PrintMsg;
        opaque = (void *)(intptr_t)priv->log.verbose;
303
304
305
306
307
308
    }

    vlc_rwlock_wrlock (&priv->log.lock);
    priv->log.cb = cb;
    priv->log.opaque = opaque;
    vlc_rwlock_unlock (&priv->log.lock);
309
310
311
312
313
314

    /* Announce who we are */
    msg_Dbg (vlc, "VLC media player - %s", VERSION_MESSAGE);
    msg_Dbg (vlc, "%s", COPYRIGHT_MESSAGE);
    msg_Dbg (vlc, "revision %s", psz_vlc_changeset);
    msg_Dbg (vlc, "configured with %s", CONFIGURE_LINE);
315
316
317
318
319
}

void vlc_LogInit (libvlc_int_t *vlc)
{
    libvlc_priv_t *priv = libvlc_priv (vlc);
320
321
322
323
324
325
326
327
328
    const char *str;

    if (var_InheritBool (vlc, "quiet"))
        priv->log.verbose = -1;
    else
    if ((str = getenv ("VLC_VERBOSE")) != NULL)
        priv->log.verbose = atoi (str);
    else
        priv->log.verbose = var_InheritInteger (vlc, "verbose");
329
330
331
332
333
334
335
336
337
338
339

    vlc_rwlock_init (&priv->log.lock);
    vlc_LogSet (vlc, NULL, NULL);
}

void vlc_LogDeinit (libvlc_int_t *vlc)
{
    libvlc_priv_t *priv = libvlc_priv (vlc);

    vlc_rwlock_destroy (&priv->log.lock);
}