]> git.sesse.net Git - vlc/blobdiff - src/misc/messages.c
Store the object type name rather than object type ID within log messages.
[vlc] / src / misc / messages.c
index 9ccbe4912195b254162935172f73abce5a58879b..7721fc49ad65c4b1c6454a880aafd9a984083689 100644 (file)
  * Preamble
  *****************************************************************************/
 
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
 #include <vlc/vlc.h>
 
-#include <stdio.h>                                               /* required */
 #include <stdarg.h>                                       /* va_list for BSD */
-#include <stdlib.h>                                              /* malloc() */
-#include <string.h>                                            /* strerror() */
 
 #ifdef HAVE_FCNTL_H
 #   include <fcntl.h>                  /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
 
 #include <errno.h>                                                  /* errno */
 
+#ifdef WIN32
+#   include <vlc_network.h>          /* 'net_strerror' and 'WSAGetLastError' */
+#endif
+
 #ifdef HAVE_UNISTD_H
 #   include <unistd.h>                                   /* close(), write() */
 #endif
 
 #include <assert.h>
 
-#include "vlc_interface.h"
-#include "charset.h"
+#include <vlc_charset.h>
 
 /*****************************************************************************
  * Local macros
@@ -79,21 +83,20 @@ static void PrintMsg ( vlc_object_t *, msg_item_t * );
  */
 void __msg_Create( vlc_object_t *p_this )
 {
-    vlc_mutex_init( p_this, &(p_this->p_libvlc->msg_bank.lock) );
-
-#define QUEUE_INIT(i) \
-    vlc_mutex_init( p_this, &QUEUE(i).lock ); \
-    QUEUE(i).b_overflow = VLC_FALSE; \
-    QUEUE(i).i_id = i; \
-    QUEUE(i).i_start = 0; \
-    QUEUE(i).i_stop = 0; \
-    QUEUE(i).i_sub = 0; \
-    QUEUE(i).pp_sub = 0;
-
-    QUEUE_INIT( 0 );
-    QUEUE_INIT( 1 );
+    int i;
+    vlc_mutex_init( (vlc_object_t *)NULL,
+                    &(p_this->p_libvlc->msg_bank.lock) );
 
-#undef QUEUE_INIT
+    for( i = 0; i < 2; i++ )
+    {
+         vlc_mutex_init( (vlc_object_t *)NULL, &QUEUE(i).lock );
+         QUEUE(i).b_overflow = VLC_FALSE;
+         QUEUE(i).i_id = i;
+         QUEUE(i).i_start = 0;
+         QUEUE(i).i_stop = 0;
+         QUEUE(i).i_sub = 0;
+         QUEUE(i).pp_sub = 0;
+    }
 
 #ifdef UNDER_CE
     QUEUE(MSG_QUEUE_NORMAL).logfile =
@@ -186,7 +189,7 @@ void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
             if( QUEUE(i).pp_sub[j] == p_sub )
             {
                 REMOVE_ELEM( QUEUE(i).pp_sub, QUEUE(i).i_sub, j );
-                if( p_sub ) free( p_sub );
+                free( p_sub );
             }
         }
         vlc_mutex_unlock( & QUEUE(i).lock );
@@ -194,35 +197,6 @@ void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
     UNLOCK_BANK;
 }
 
-const char *msg_GetObjectTypeName(int i_object_type )
-{
-    switch( i_object_type )
-    {
-        case VLC_OBJECT_GLOBAL: return "global";
-        case VLC_OBJECT_LIBVLC: return "libvlc";
-        case VLC_OBJECT_MODULE: return "module";
-        case VLC_OBJECT_INTF: return "interface";
-        case VLC_OBJECT_PLAYLIST: return "playlist";
-        case VLC_OBJECT_ITEM: return "item";
-        case VLC_OBJECT_INPUT: return "input";
-        case VLC_OBJECT_DECODER: return "decoder";
-        case VLC_OBJECT_PACKETIZER: return "packetizer";
-        case VLC_OBJECT_ENCODER: return "encoder";
-        case VLC_OBJECT_VOUT: return "video output";
-        case VLC_OBJECT_AOUT: return "audio output";
-        case VLC_OBJECT_SOUT: return "stream output";
-        case VLC_OBJECT_HTTPD: return "http server";
-        case VLC_OBJECT_HTTPD_HOST: return "http server";
-        case VLC_OBJECT_DIALOGS: return "dialogs provider";
-        case VLC_OBJECT_VLM: return "vlm";
-        case VLC_OBJECT_ANNOUNCE: return "announce handler";
-        case VLC_OBJECT_DEMUX: return "demuxer";
-        case VLC_OBJECT_ACCESS: return "access";
-        case VLC_OBJECT_META_ENGINE: return "meta engine";
-        default: return "private";
-    }
-}
-
 /*****************************************************************************
  * __msg_*: print a message
  *****************************************************************************
@@ -252,7 +226,7 @@ void __msg_GenericVa( vlc_object_t *p_this, int i_queue,
     { \
         va_list args; \
         va_start( args, psz_format ); \
-        QueueMsg( (vlc_object_t *)p_this,MSG_QUEUE_NORMAL, FN_TYPE, "unknown", \
+        QueueMsg( p_this,MSG_QUEUE_NORMAL, FN_TYPE, "unknown", \
                   psz_format, args ); \
         va_end( args ); \
     } \
@@ -301,25 +275,103 @@ static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
     int          i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
 #endif
 
-    if( p_this == NULL || p_this->i_flags & OBJECT_FLAGS_QUIET ||
-        (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
+    if( p_this == NULL )
     {
+#ifndef NDEBUG
+        if( i_type == VLC_MSG_DBG )
+            return;
+#endif
+        utf8_vfprintf( stderr, psz_format, _args );
+        fputc ('\n', stderr);
         return;
     }
 
+    if( p_this->i_flags & OBJECT_FLAGS_QUIET ||
+        (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
+        return;
+
+#ifndef __GLIBC__
+    /* Expand %m to strerror(errno) - only once */
+    char buf[strlen( psz_format ) + 2001], *ptr;
+    strcpy( buf, psz_format );
+    ptr = (char*)buf;
+    psz_format = (const char*) buf;
+
+    for( ;; )
+    {
+        ptr = strchr( ptr, '%' );
+        if( ptr == NULL )
+            break;
+
+        if( ptr[1] == 'm' )
+        {
+            char errbuf[2001];
+            size_t errlen;
+
+#ifndef WIN32
+            strerror_r( errno, errbuf, 1001 );
+#else
+            int sockerr = WSAGetLastError( );
+            if( sockerr )
+            {
+                strncpy( errbuf, net_strerror( sockerr ), 1001 );
+                WSASetLastError( sockerr );
+            }
+            if ((sockerr == 0)
+             || (strcmp ("Unknown network stack error", errbuf) == 0))
+                strncpy( errbuf, strerror( errno ), 1001 );
+#endif
+            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
+
     /* Convert message to string  */
 #if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS )
     vlc_va_copy( args, _args );
-    vasprintf( &psz_str, psz_format, args );
+    if( vasprintf( &psz_str, psz_format, args ) == -1 )
+        psz_str = NULL;
     va_end( args );
 #else
-    psz_str = (char*) malloc( i_size * sizeof(char) );
+    psz_str = (char*) malloc( i_size );
 #endif
 
     if( psz_str == NULL )
     {
-        fprintf( stderr, "main warning: can't store message (%s): ",
-                 strerror(errno) );
+#ifdef __GLIBC__
+        fprintf( stderr, "main warning: can't store message (%m): " );
+#else
+        char psz_err[1001];
+#ifndef WIN32
+        /* we're not using GLIBC, so we are sure that the error description
+         * will be stored in the buffer we provide to strerror_r() */
+        strerror_r( errno, psz_err, 1001 );
+#else
+        strncpy( psz_err, strerror( errno ), 1001 );
+#endif
+        psz_err[1000] = '\0';
+        fprintf( stderr, "main warning: can't store message (%s): ", psz_err );
+#endif
         vlc_va_copy( args, _args );
         /* We should use utf8_vfprintf - but it calls malloc()... */
         vfprintf( stderr, psz_format, args );
@@ -350,7 +402,7 @@ static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
                           p_obj->psz_header );
             }
         }
-        if( psz_old ) free( psz_old );
+        free( psz_old );
         p_obj = p_obj->p_parent;
     }
 
@@ -398,7 +450,7 @@ static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
 
                 p_item->i_type =        VLC_MSG_WARN;
                 p_item->i_object_id =   p_this->i_object_id;
-                p_item->i_object_type = p_this->i_object_type;
+                p_item->psz_object_type = p_this->psz_object_type;
                 p_item->psz_module =    strdup( "message" );
                 p_item->psz_msg =       strdup( "message queue overflowed" );
                 p_item->psz_header =    NULL;
@@ -420,7 +472,7 @@ static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
     /* Fill message information fields */
     p_item->i_type =        i_type;
     p_item->i_object_id =   p_this->i_object_id;
-    p_item->i_object_type = p_this->i_object_type;
+    p_item->psz_object_type = p_this->psz_object_type;
     p_item->psz_module =    strdup( psz_module );
     p_item->psz_msg =       psz_str;
     p_item->psz_header =    psz_header;
@@ -430,12 +482,9 @@ static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
 
     if( p_queue->b_overflow )
     {
-        if( p_item->psz_module )
-            free( p_item->psz_module );
-        if( p_item->psz_msg )
-            free( p_item->psz_msg );
-        if( p_item->psz_header )
-            free( p_item->psz_header );
+        free( p_item->psz_module );
+        free( p_item->psz_msg );
+        free( p_item->psz_header );
     }
 
     vlc_mutex_unlock ( &p_queue->lock );
@@ -478,12 +527,9 @@ static void FlushMsg ( msg_queue_t *p_queue )
          i_index != i_stop;
          i_index = (i_index+1) % VLC_MSG_QSIZE )
     {
-        if( p_queue->msg[i_index].psz_msg )
-            free( p_queue->msg[i_index].psz_msg );
-        if( p_queue->msg[i_index].psz_module )
-            free( p_queue->msg[i_index].psz_module );
-        if( p_queue->msg[i_index].psz_header )
-            free( p_queue->msg[i_index].psz_header );
+        free( p_queue->msg[i_index].psz_msg );
+        free( p_queue->msg[i_index].psz_module );
+        free( p_queue->msg[i_index].psz_header );
     }
 
     /* Update the new start value */
@@ -501,7 +547,7 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
 #   define RED     COL(31)
 #   define GREEN   COL(32)
 #   define YELLOW  COL(33)
-#   define WHITE   COL(37)
+#   define WHITE   COL(0)
 #   define GRAY    "\033[0m"
 
 #ifdef UNDER_CE
@@ -528,7 +574,7 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
             break;
     }
 
-    psz_object = msg_GetObjectTypeName(p_item->i_object_type);
+    psz_object = p_item->psz_object_type;
 
 #ifdef UNDER_CE
 #   define CE_WRITE(str) WriteFile( QUEUE(MSG_QUEUE_NORMAL).logfile, \
@@ -584,3 +630,65 @@ static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
 #   endif
 #endif
 }
+
+static msg_context_t* GetContext(void)
+{
+    msg_context_t *p_ctx = vlc_threadvar_get( &msg_context_global_key );
+    if( p_ctx == NULL )
+    {
+        MALLOC_NULL( p_ctx, msg_context_t );
+        p_ctx->psz_message = NULL;
+        vlc_threadvar_set( &msg_context_global_key, p_ctx );
+    }
+    return p_ctx;
+}
+
+void msg_StackSet( int i_code, const char *psz_message, ... )
+{
+    va_list ap;
+    msg_context_t *p_ctx = GetContext();
+    assert( p_ctx );
+
+    va_start( ap, psz_message );
+    free( p_ctx->psz_message );
+
+    if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
+        p_ctx->psz_message = NULL;
+    va_end( ap );
+
+    p_ctx->i_code = i_code;
+}
+
+void msg_StackAdd( const char *psz_message, ... )
+{
+    char *psz_tmp;
+    va_list ap;
+    msg_context_t *p_ctx = GetContext();
+    assert( p_ctx );
+
+    va_start( ap, psz_message );
+    if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
+        psz_tmp = NULL;
+    va_end( ap );
+
+    if( !p_ctx->psz_message )
+        p_ctx->psz_message = psz_tmp;
+    else
+    {
+        char *psz_old = malloc( strlen( p_ctx->psz_message ) + 1 );
+        memcpy( psz_old, p_ctx->psz_message, strlen( p_ctx->psz_message ) + 1 );
+        p_ctx->psz_message = realloc( p_ctx->psz_message,
+                                      strlen( p_ctx->psz_message ) +
+                                      /* ':', ' ', '0' */
+                                      strlen( psz_tmp ) + 3 );
+        sprintf( p_ctx->psz_message, "%s: %s", psz_tmp, psz_old );
+        free( psz_tmp ); free( psz_old );
+    }
+}
+
+const char* msg_StackMsg( void )
+{
+    msg_context_t *p_ctx = GetContext();
+    assert( p_ctx );
+    return p_ctx->psz_message;
+}