* 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 <stdarg.h>
#include <assert.h>
-#ifdef UNDER_CE
-# define _IONBF 0x0004
-#endif
-
#define MODE_TEXT 0
#define MODE_HTML 1
#define MODE_SYSLOG 2
#define LOG_FILE_TEXT "vlc-log.txt"
#define LOG_FILE_HTML "vlc-log.html"
-#define TEXT_HEADER "-- logger module started --\n"
+#define TEXT_HEADER "\xEF\xBB\xBF-- logger module started --\n"
#define TEXT_FOOTER "-- logger module stopped --\n"
#define HTML_HEADER \
" </head>\n" \
" <body style=\"background-color: #000000; color: #aaaaaa;\">\n" \
" <pre>\n" \
- " <b>-- logger module started --</b>\n"
+ " <strong>-- logger module started --</strong>\n"
#define HTML_FOOTER \
- " <b>-- logger module stopped --</b>\n" \
+ " <strong>-- logger module stopped --</strong>\n" \
" </pre>\n" \
" </body>\n" \
"</html>\n"
-#if HAVE_SYSLOG_H
+#ifdef HAVE_SYSLOG_H
#include <syslog.h>
#endif
-struct msg_cb_data_t
-{
- intf_thread_t *p_intf;
- FILE *p_file;
- int i_mode;
-};
-
/*****************************************************************************
* intf_sys_t: description and status of log interface
*****************************************************************************/
struct intf_sys_t
{
- struct
- {
- FILE *stream;
- vlc_thread_t thread;
- } rrd;
-
msg_subscription_t *p_sub;
- msg_cb_data_t msg;
+ FILE *p_file;
+ const char *footer;
};
/*****************************************************************************
static int Open ( vlc_object_t * );
static void Close ( vlc_object_t * );
-static void Overflow (msg_cb_data_t *p_sys, msg_item_t *p_item, unsigned overruns);
-static void TextPrint ( const msg_item_t *, FILE * );
-static void HtmlPrint ( const msg_item_t *, FILE * );
+static void TextPrint(void *, int, const msg_item_t *, const char *, va_list);
+static void HtmlPrint(void *, int, const msg_item_t *, const char *, va_list);
#ifdef HAVE_SYSLOG_H
-static void SyslogPrint ( const msg_item_t *);
+static void SyslogPrint(void *, int, const msg_item_t *, const char *,
+ va_list);
#endif
-static void *DoRRD( void * );
-
/*****************************************************************************
* Module descriptor
*****************************************************************************/
};
#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
+#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 )
- add_file( "logfile", NULL, NULL,
- 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 );
+ add_savefile( "logfile", NULL,
+ N_("Log filename"), N_("Specify the log filename."), false )
+ add_string( "logmode", "text", LOGMODE_TEXT, LOGMODE_LONGTEXT,
+ false )
+ change_string_list( mode_list, mode_list_text, 0 )
+#ifdef HAVE_SYSLOG_H
+ add_string( "syslog-facility", fac_name[0], SYSLOG_FACILITY_TEXT,
+ SYSLOG_FACILITY_LONGTEXT, true )
+ change_string_list( fac_name, fac_name, 0 )
+#endif
+ add_integer( "log-verbose", -1, LOGVERBOSE_TEXT, LOGVERBOSE_LONGTEXT,
+ false )
+
+ add_obsolete_string( "rrd-file" )
set_capability( "interface", 0 )
set_callbacks( Open, Close )
{
intf_thread_t *p_intf = (intf_thread_t *)p_this;
intf_sys_t *p_sys;
- char *psz_mode, *psz_rrd_file;
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 ) );
if( p_sys == NULL )
return VLC_ENOMEM;
- p_sys->msg.p_intf = p_intf;
- p_sys->msg.i_mode = MODE_TEXT;
- psz_mode = var_CreateGetString( p_intf, "logmode" );
- if( psz_mode )
+ msg_callback_t cb = TextPrint;
+ const char *filename = LOG_FILE_TEXT, *header = TEXT_HEADER;
+ p_sys->footer = TEXT_FOOTER;
+
+ char *mode = var_InheritString( p_intf, "logmode" );
+ if( mode != NULL )
{
- if( !strcmp( psz_mode, "text" ) )
- ;
- else if( !strcmp( psz_mode, "html" ) )
+ if( !strcmp( mode, "html" ) )
{
- p_sys->msg.i_mode = MODE_HTML;
+ p_sys->footer = HTML_FOOTER;
+ header = HTML_HEADER;
+ cb = HtmlPrint;
}
#ifdef HAVE_SYSLOG_H
- else if( !strcmp( psz_mode, "syslog" ) )
+ else if( !strcmp( mode, "syslog" ) )
+ cb = SyslogPrint;
+#endif
+ else if( strcmp( mode, "text" ) )
+ msg_Warn( p_intf, "invalid log mode `%s', using `text'", mode );
+ free( mode );
+ }
+
+#ifdef HAVE_SYSLOG_H
+ if( cb == SyslogPrint )
+ {
+ int i_facility;
+ char *psz_facility = var_InheritString( p_intf, "syslog-facility" );
+ if( psz_facility )
{
- p_sys->msg.i_mode = MODE_SYSLOG;
+ 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 )
+ {
+ msg_Warn( p_intf, "invalid syslog facility `%s', using `%s'",
+ psz_facility, fac_name[0] );
+ i_facility = fac_number[0];
+ }
+ free( psz_facility );
}
-#endif
else
{
- msg_Warn( p_intf, "invalid log mode `%s', using `text'", psz_mode );
- p_sys->msg.i_mode = MODE_TEXT;
+ msg_Warn( p_intf, "no syslog facility specified, using `%s'",
+ fac_name[0] );
+ i_facility = fac_number[0];
}
- free( psz_mode );
+
+ openlog( "vlc", LOG_PID|LOG_NDELAY, i_facility );
+ p_sys->p_file = NULL;
}
else
+#endif
{
- msg_Warn( p_intf, "no log mode specified, using `text'" );
- }
-
- 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->msg.i_mode == MODE_HTML) ? LOG_FILE_HTML
- : LOG_FILE_TEXT ) == -1 )
+ char *home = config_GetUserDir(VLC_DOCUMENTS_DIR);
+ if( home == NULL
+ || asprintf( &psz_file, "%s/"LOG_DIR"/%s", home,
+ filename ) == -1 )
psz_file = NULL;
-#else
- switch( p_sys->msg.i_mode )
- {
- case MODE_HTML:
- psz_file = strdup( LOG_FILE_HTML );
- break;
- case MODE_TEXT:
- default:
- psz_file = strdup( LOG_FILE_TEXT );
- break;
- }
+ free(home);
+ filename = psz_file;
#endif
msg_Warn( p_intf, "no log filename provided, using `%s'",
- psz_file );
+ filename );
}
+ else
+ filename = psz_file;
/* 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" );
- if( p_sys->msg.p_file == NULL )
- {
- msg_Err( p_intf, "error opening logfile `%s'", psz_file );
- free( p_sys );
- free( psz_file );
- return -1;
- }
- setvbuf( p_sys->msg.p_file, NULL, _IONBF, 0 );
-
+ msg_Dbg( p_intf, "opening logfile `%s'", filename );
+ p_sys->p_file = vlc_fopen( filename, "at" );
free( psz_file );
-
- switch( p_sys->msg.i_mode )
+ if( p_sys->p_file == NULL )
{
- case MODE_HTML:
- fputs( HTML_HEADER, p_sys->msg.p_file );
- break;
- case MODE_TEXT:
- default:
- fputs( TEXT_HEADER, p_sys->msg.p_file );
- break;
- }
-
- }
- else
- {
- 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)
- {
- 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
- {
- fclose (rrd);
- p_sys->rrd.stream = NULL;
- }
+ msg_Err( p_intf, "error opening logfile `%s': %m", filename );
+ free( p_sys );
+ return VLC_EGENERIC;
}
+ setvbuf( p_sys->p_file, NULL, _IONBF, 0 );
+ fputs( header, p_sys->p_file );
}
- else
- p_sys->rrd.stream = NULL;
- free( psz_rrd_file );
-
- p_sys->p_sub = msg_Subscribe( p_intf->p_libvlc, Overflow, &p_sys->msg );
- return 0;
+ p_sys->p_sub = vlc_Subscribe( cb, p_intf );
+ return VLC_SUCCESS;
}
/*****************************************************************************
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 );
+ vlc_Unsubscribe( p_sys->p_sub );
- switch( p_sys->msg.i_mode )
- {
- case MODE_HTML:
- fputs( HTML_FOOTER, p_sys->msg.p_file );
- break;
+ /* Close the log file */
#ifdef HAVE_SYSLOG_H
- case MODE_SYSLOG:
+ if( p_sys->p_file == NULL )
closelog();
- break;
+ else
#endif
- case MODE_TEXT:
- default:
- fputs( TEXT_FOOTER, p_sys->msg.p_file );
- break;
+ {
+ fputs( p_sys->footer, p_sys->p_file );
+ fclose( p_sys->p_file );
}
- /* Close the log file */
- if( p_sys->msg.p_file )
- fclose( p_sys->msg.p_file );
-
/* Destroy structure */
free( p_sys );
}
-/**
- * Log a message
- */
-static void Overflow (msg_cb_data_t *p_sys, msg_item_t *p_item, unsigned overruns)
+static bool IgnoreMessage( intf_thread_t *p_intf, int type )
{
- int verbosity = var_CreateGetInteger( p_sys->p_intf, "verbose" );
- int priority = 0;
-
- switch( p_item->i_type )
- {
- case VLC_MSG_WARN: priority = 1; break;
- case VLC_MSG_DBG: priority = 2; break;
- }
- if (verbosity < priority)
- return;
+ /* TODO: cache value... */
+ int verbosity = var_InheritInteger( p_intf, "log-verbose" );
+ if (verbosity == -1)
+ verbosity = var_InheritInteger( p_intf, "verbose" );
- switch( p_sys->i_mode )
- {
- case MODE_HTML:
- HtmlPrint( p_item, p_sys->p_file );
- break;
-#ifdef HAVE_SYSLOG_H
- case MODE_SYSLOG:
- SyslogPrint( p_item );
- break;
-#endif
- case MODE_TEXT:
- default:
- TextPrint( p_item, p_sys->p_file );
- break;
- }
+ return verbosity < 0 || verbosity < (type - VLC_MSG_ERR);
}
-static const char ppsz_type[4][11] = {
- ": ",
- " error: ",
- " warning: ",
- " debug: ",
+/*
+ * Logging callbacks
+ */
+
+static const char ppsz_type[4][9] = {
+ "",
+ " error",
+ " warning",
+ " debug",
};
-static void TextPrint( const msg_item_t *p_msg, FILE *p_file )
+static void TextPrint( void *opaque, int type, const msg_item_t *item,
+ const char *fmt, va_list ap )
{
- fprintf( p_file, "%s%s%s\n", p_msg->psz_module, ppsz_type[p_msg->i_type],
- p_msg->psz_msg );
+ intf_thread_t *p_intf = opaque;
+ FILE *stream = p_intf->p_sys->p_file;
+
+ if( IgnoreMessage( p_intf, type ) )
+ return;
+
+ int canc = vlc_savecancel();
+ flockfile( stream );
+ fprintf( stream, "%s%s: ", item->psz_module, ppsz_type[type] );
+ vfprintf( stream, fmt, ap );
+ putc_unlocked( '\n', stream );
+ funlockfile( stream );
+ vlc_restorecancel( canc );
}
#ifdef HAVE_SYSLOG_H
-static void SyslogPrint( const msg_item_t *p_msg )
+static void SyslogPrint( void *opaque, int type, const msg_item_t *item,
+ const char *fmt, va_list ap )
{
static const int i_prio[4] = { LOG_INFO, LOG_ERR, LOG_WARNING, LOG_DEBUG };
- 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 );
+ intf_thread_t *p_intf = opaque;
+ char *str;
+ int i_priority = i_prio[type];
+
+ if( IgnoreMessage( p_intf, type )
+ || unlikely(vasprintf( &str, fmt, ap ) == -1) )
+ return;
+
+ int canc = vlc_savecancel();
+ if( item->psz_header != NULL )
+ syslog( i_priority, "[%s] %s%s: %s", item->psz_header,
+ item->psz_module, ppsz_type[type], str );
else
- syslog( i_priority, "%s%s: %s", p_msg->psz_module,
- ppsz_type[p_msg->i_type], p_msg->psz_msg );
-
+ syslog( i_priority, "%s%s: %s",
+ item->psz_module, ppsz_type[type], str );
+ vlc_restorecancel( canc );
+ free( str );
}
#endif
-static void HtmlPrint( const msg_item_t *p_msg, FILE *p_file )
+static void HtmlPrint( void *opaque, int type, const msg_item_t *item,
+ const char *fmt, va_list ap )
{
- static const char ppsz_color[4][30] = {
- "<span style=\"color: #ffffff\">",
- "<span style=\"color: #ff6666\">",
- "<span style=\"color: #ffff66\">",
- "<span style=\"color: #aaaaaa\">",
+ static const unsigned color[4] = {
+ 0xffffff, 0xff6666, 0xffff66, 0xaaaaaa,
};
- fprintf( p_file, "%s%s%s%s</span>\n", p_msg->psz_module,
- ppsz_type[p_msg->i_type], ppsz_color[p_msg->i_type],
- p_msg->psz_msg );
-}
+ intf_thread_t *p_intf = opaque;
+ FILE *stream = p_intf->p_sys->p_file;
-static void *DoRRD (void *data)
-{
- intf_thread_t *p_intf = data;
- FILE *file = p_intf->p_sys->rrd.stream;
+ if( IgnoreMessage( p_intf, type ) )
+ return;
- 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);
+ int canc = vlc_savecancel();
+ flockfile( stream );
+ fprintf( stream, "%s%s: <span style=\"color: #%06x\">",
+ item->psz_module, ppsz_type[type], color[type] );
+ /* FIXME: encode special ASCII characters */
+ fprintf( stream, fmt, ap );
+ fputs( "</span>\n", stream );
+ funlockfile( stream );
+ vlc_restorecancel( canc );
}
projects / vlc / blobdiff