]> git.sesse.net Git - vlc/blobdiff - modules/misc/logger.c
Qt: sprefs_audio fix layout
[vlc] / modules / misc / logger.c
index 45d25888956f31a20a40129295c89a7915bf2be0..e8347227c3d6ac559d8f1b92fc910acb68f36de6 100644 (file)
@@ -16,9 +16,9 @@
  * 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
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU 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.
  *****************************************************************************/
 
 /*****************************************************************************
 #include <vlc_common.h>
 #include <vlc_plugin.h>
 #include <vlc_interface.h>
-#include <vlc_playlist.h>
+#include <vlc_fs.h>
 #include <vlc_charset.h>
 
 #include <assert.h>
 
-#ifdef UNDER_CE
-#   define _IONBF 0x0004
-#endif
-
 #define MODE_TEXT 0
 #define MODE_HTML 1
 #define MODE_SYSLOG 2
@@ -72,7 +68,7 @@
     "  </body>\n" \
     "</html>\n"
 
-#if HAVE_SYSLOG_H
+#ifdef HAVE_SYSLOG_H
 #include <syslog.h>
 #endif
 
@@ -88,12 +84,6 @@ struct msg_cb_data_t
  *****************************************************************************/
 struct intf_sys_t
 {
-    struct
-    {
-        FILE *stream;
-        vlc_thread_t thread;
-    } rrd;
-
     msg_subscription_t *p_sub;
     msg_cb_data_t msg;
 };
@@ -111,8 +101,6 @@ static void HtmlPrint         ( const msg_item_t *, FILE * );
 static void SyslogPrint       ( const msg_item_t *);
 #endif
 
-static void *DoRRD( void * );
-
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
@@ -128,34 +116,73 @@ static const char *const mode_list_text[] = { N_("Text"), "HTML"
 };
 
 #define LOGMODE_TEXT N_("Log format")
-#ifdef HAVE_SYSLOG_H
+#ifndef HAVE_SYSLOG_H
 #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.")
+  "\"text\" (default) and \"html\".")
 #else
+
 #define LOGMODE_LONGTEXT N_("Specify the log format. Available choices are " \
-  "\"text\" (default) and \"html\".")
+  "\"text\" (default), \"html\", and \"syslog\" (special mode to send to " \
+  "syslog instead of file.")
+
+#define SYSLOG_FACILITY_TEXT N_("Syslog facility")
+#define SYSLOG_FACILITY_LONGTEXT N_("Select the syslog facility where logs " \
+  "will be forwarded. Available choices are \"user\" (default), \"daemon\", " \
+  "and \"local0\" through \"local7\".")
+
+/* First in list is the default facility used. */
+#define DEFINE_SYSLOG_FACILITY \
+  DEF( "user",   LOG_USER ), \
+  DEF( "daemon", LOG_DAEMON ), \
+  DEF( "local0", LOG_LOCAL0 ), \
+  DEF( "local1", LOG_LOCAL1 ), \
+  DEF( "local2", LOG_LOCAL2 ), \
+  DEF( "local3", LOG_LOCAL3 ), \
+  DEF( "local4", LOG_LOCAL4 ), \
+  DEF( "local5", LOG_LOCAL5 ), \
+  DEF( "local6", LOG_LOCAL6 ), \
+  DEF( "local7", LOG_LOCAL7 )
+
+#define DEF( a, b ) a
+static const char *const fac_name[]   = { DEFINE_SYSLOG_FACILITY };
+#undef  DEF
+#define DEF( a, b ) b
+static const int         fac_number[] = { DEFINE_SYSLOG_FACILITY };
+#undef  DEF
+enum                   { fac_entries = sizeof(fac_name)/sizeof(fac_name[0]) };
+#undef  DEFINE_SYSLOG_FACILITY
+
 #endif
 
-vlc_module_begin();
-    set_shortname( N_( "Logging" ) );
-    set_description( N_("File logging") );
+#define LOGVERBOSE_TEXT N_("Verbosity")
+#define LOGVERBOSE_LONGTEXT N_("Select the verbosity to use for log or -1 to " \
+"use the same verbosity given by --verbose.")
+
+vlc_module_begin ()
+    set_shortname( N_( "Logging" ) )
+    set_description( N_("File logging") )
 
-    set_category( CAT_ADVANCED );
-    set_subcategory( SUBCAT_ADVANCED_MISC );
+    set_category( CAT_ADVANCED )
+    set_subcategory( SUBCAT_ADVANCED_MISC )
 
     add_file( "logfile", NULL, NULL,
-             N_("Log filename"), N_("Specify the log filename."), false );
+             N_("Log filename"), N_("Specify the log filename."), false )
     add_string( "logmode", "text", NULL, LOGMODE_TEXT, LOGMODE_LONGTEXT,
-                false );
-        change_string_list( mode_list, mode_list_text, 0 );
-
-    add_file( "rrd-file", NULL, NULL, N_("RRD output file") ,
-                    N_("Output data for RRDTool in this file." ), true );
+                false )
+        change_string_list( mode_list, mode_list_text, 0 )
+#ifdef HAVE_SYSLOG_H
+    add_string( "syslog-facility", fac_name[0], NULL, SYSLOG_FACILITY_TEXT,
+                SYSLOG_FACILITY_LONGTEXT, true )
+        change_string_list( fac_name, fac_name, 0 )
+#endif
+    add_integer( "log-verbose", -1, NULL, LOGVERBOSE_TEXT, LOGVERBOSE_LONGTEXT,
+           false )
+    
+    add_obsolete_string( "rrd-file" )
 
-    set_capability( "interface", 0 );
-    set_callbacks( Open, Close );
-vlc_module_end();
+    set_capability( "interface", 0 )
+    set_callbacks( Open, Close )
+vlc_module_end ()
 
 /*****************************************************************************
  * Open: initialize and create stuff
@@ -164,10 +191,10 @@ static int Open( vlc_object_t *p_this )
 {
     intf_thread_t *p_intf = (intf_thread_t *)p_this;
     intf_sys_t *p_sys;
-    char *psz_mode, *psz_rrd_file;
+    char *psz_mode;
 
     CONSOLE_INTRO_MSG;
-    msg_Info( p_intf, "using logger..." );
+    msg_Info( p_intf, "using logger." );
 
     /* Allocate instance and initialize some members */
     p_sys = p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
@@ -205,14 +232,17 @@ static int Open( vlc_object_t *p_this )
 
     if( p_sys->msg.i_mode != MODE_SYSLOG )
     {
-        char *psz_file = config_GetPsz( p_intf, "logfile" );
+        char *psz_file = var_InheritString( p_intf, "logfile" );
         if( !psz_file )
         {
 #ifdef __APPLE__
-            if( asprintf( &psz_file, "%s/"LOG_DIR"/%s", config_GetHomeDir(),
-                (p_sys->i_mode == MODE_HTML) ? LOG_FILE_HTML
+            char *home = config_GetUserDir(VLC_DOCUMENTS_DIR);
+            if( home == NULL
+             || asprintf( &psz_file, "%s/"LOG_DIR"/%s", home,
+                (p_sys->msg.i_mode == MODE_HTML) ? LOG_FILE_HTML
                                              : LOG_FILE_TEXT ) == -1 )
                 psz_file = NULL;
+            free(home);
 #else
             switch( p_sys->msg.i_mode )
             {
@@ -231,7 +261,7 @@ static int Open( vlc_object_t *p_this )
 
         /* Open the log file and remove any buffering for the stream */
         msg_Dbg( p_intf, "opening logfile `%s'", psz_file );
-        p_sys->msg.p_file = utf8_fopen( psz_file, "at" );
+        p_sys->msg.p_file = vlc_fopen( psz_file, "at" );
         if( p_sys->msg.p_file == NULL )
         {
             msg_Err( p_intf, "error opening logfile `%s'", psz_file );
@@ -259,30 +289,38 @@ static int Open( vlc_object_t *p_this )
     {
         p_sys->msg.p_file = NULL;
 #ifdef HAVE_SYSLOG_H
-        openlog( "vlc", LOG_PID|LOG_NDELAY, LOG_DAEMON );
-#endif
-    }
-
-    psz_rrd_file = config_GetPsz( p_intf, "rrd-file" );
-    if( psz_rrd_file && *psz_rrd_file )
-    {
-        FILE *rrd = utf8_fopen( psz_rrd_file, "w" );
-        if (rrd != NULL)
+        int i_facility;
+        char *psz_facility = var_CreateGetString( p_intf, "syslog-facility" );
+        if( psz_facility )
         {
-            setvbuf (rrd, NULL, _IOLBF, BUFSIZ);
-            if (!vlc_clone (&p_sys->rrd.thread, DoRRD, p_intf,
-                            VLC_THREAD_PRIORITY_LOW))
-                p_sys->rrd.stream = rrd;
-            else
+            bool b_valid = 0;
+            for( size_t i = 0; i < fac_entries; ++i )
+            {
+                if( !strcmp( psz_facility, fac_name[i] ) )
+                {
+                    i_facility = fac_number[i];
+                    b_valid = 1;
+                    break;
+                }
+            }
+            if( !b_valid )
             {
-                fclose (rrd);
-                p_sys->rrd.stream = NULL;
+                msg_Warn( p_intf, "invalid syslog facility `%s', using `%s'",
+                          psz_facility, fac_name[0] );
+                i_facility = fac_number[0];
             }
+            free( psz_facility );
         }
+        else
+        {
+            msg_Warn( p_intf, "no syslog facility specified, using `%s'",
+                      fac_name[0] );
+            i_facility = fac_number[0];
+        }
+
+        openlog( "vlc", LOG_PID|LOG_NDELAY, i_facility );
+#endif
     }
-    else
-        p_sys->rrd.stream = NULL;
-    free( psz_rrd_file );
 
     p_sys->p_sub = msg_Subscribe( p_intf->p_libvlc, Overflow, &p_sys->msg );
 
@@ -297,12 +335,6 @@ static void Close( vlc_object_t *p_this )
     intf_thread_t *p_intf = (intf_thread_t *)p_this;
     intf_sys_t *p_sys = p_intf->p_sys;
 
-    if (p_sys->rrd.stream)
-    {
-        vlc_cancel (p_sys->rrd.thread);
-        vlc_join (p_sys->rrd.thread, NULL);
-    }
-
     /* Flush the queue and unsubscribe from the message queue */
     /* FIXME: flush */
     msg_Unsubscribe( p_sys->p_sub );
@@ -336,16 +368,27 @@ static void Close( vlc_object_t *p_this )
  */
 static void Overflow (msg_cb_data_t *p_sys, msg_item_t *p_item, unsigned overruns)
 {
-    int verbosity = var_CreateGetInteger( p_sys->p_intf, "verbose" );
-    int priority = 0;
+    VLC_UNUSED(overruns);
+    int verbosity = var_CreateGetInteger( p_sys->p_intf, "log-verbose" );
+    if (verbosity == -1)
+        verbosity = var_CreateGetInteger( p_sys->p_intf, "verbose" );
 
     switch( p_item->i_type )
     {
-        case VLC_MSG_WARN: priority = 1; break;
-        case VLC_MSG_DBG:  priority = 2; break;
+        case VLC_MSG_INFO:
+        case VLC_MSG_ERR:
+            if( verbosity < 0 ) return;
+            break;
+        case VLC_MSG_WARN:
+            if( verbosity < 1 ) return;
+            break;
+        case VLC_MSG_DBG:
+            if( verbosity < 2 ) return;
+            break;
     }
-    if (verbosity < priority)
-        return;
+
+
+    int canc = vlc_savecancel();
 
     switch( p_sys->i_mode )
     {
@@ -362,6 +405,8 @@ static void Overflow (msg_cb_data_t *p_sys, msg_item_t *p_item, unsigned overrun
             TextPrint( p_item, p_sys->p_file );
             break;
     }
+
+    vlc_restorecancel( canc );
 }
 
 static const char ppsz_type[4][11] = {
@@ -373,8 +418,8 @@ static const char ppsz_type[4][11] = {
 
 static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
 {
-    fprintf( p_file, "%s%s%s\n", p_msg->psz_module, ppsz_type[p_msg->i_type],
-             p_msg->psz_msg );
+    utf8_fprintf( p_file, "%s%s%s\n", p_msg->psz_module,
+                  ppsz_type[p_msg->i_type], p_msg->psz_msg );
 }
 
 #ifdef HAVE_SYSLOG_H
@@ -384,11 +429,10 @@ static void SyslogPrint( const msg_item_t *p_msg )
     int i_priority = i_prio[p_msg->i_type];
 
     if( p_msg->psz_header )
-        syslog( i_priority, "%s%s %s: %s", p_msg->psz_header,
-                ppsz_type[p_msg->i_type],
-                p_msg->psz_module, p_msg->psz_msg );
+        syslog( i_priority, "%s %s%s%s", p_msg->psz_header, p_msg->psz_module,
+                ppsz_type[p_msg->i_type], p_msg->psz_msg );
     else
-        syslog( i_priority, "%s%s%s", p_msg->psz_module, 
+        syslog( i_priority, "%s%s%s", p_msg->psz_module, 
                 ppsz_type[p_msg->i_type], p_msg->psz_msg );
  
 }
@@ -407,30 +451,3 @@ static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
              ppsz_type[p_msg->i_type], ppsz_color[p_msg->i_type],
              p_msg->psz_msg );
 }
-
-static void *DoRRD (void *data)
-{
-    intf_thread_t *p_intf = data;
-    FILE *file = p_intf->p_sys->rrd.stream;
-
-    for (;;)
-    {
-        /* FIXME: I wonder how memory synchronization occurs here...
-         * -- Courmisch */
-        if( p_intf->p_libvlc->p_stats )
-        {
-            lldiv_t in = lldiv( p_intf->p_libvlc->p_stats->f_input_bitrate * 1000000,
-                                1000 );
-            lldiv_t dm = lldiv( p_intf->p_libvlc->p_stats->f_demux_bitrate * 1000000,
-                                1000 );
-            lldiv_t out = lldiv( p_intf->p_libvlc->p_stats->f_output_bitrate * 1000000,
-                                1000 );
-            fprintf( file,
-                    "%"PRIi64":%lld.%03llu:%lld.%03llu:%lld.%03llu\n",
-                    (int64_t)time(NULL), in.quot, in.rem, dm.quot, dm.rem, out.quot, out.rem );
-        }
-#undef msleep /* yeah, we really want to wake up every second here */
-        msleep (CLOCK_FREQ);
-    }
-    assert (0);
-}