Log_console Bug?

Hi I think there is a bug in Log_console, well at least there appears to be one when using Fedora Core 3, php 5.0.3 For example: <code> require "Log.php"; $logger = &Log::singleton('console', '', 'ident'); for ($i = 0; $i < 10; $i++) { $logger->log("Log entry $i"); } </code> Will produce: Warning: fwrite(): supplied argument is not a valid stream resource in /usr/share/pear/Log/console.php on line 180 This is becuase on line 180 Log_console is attempting to do the following: fwrite($this->_stream); (where stream is equal to the string STDOUT, not a resource) You can specifiy the stream as a resource, however this does not get round the problem if you want to use the default mode. I have attached a unified diff of my changes, and also my changes so that it can be tested. Basically in the constructor it uses fopen to open up the stream so $this->_stream is a resource and can be fwrite'd to. In the destructor it makes a fclose call. Note, i don't think the constructor is the best place to open up the stream, perhaps it should only open up upon the first Log::log call? That would allow the proper return of an error if it couldn't open up the file. Thanks Alex ps. If i totally missed the point, please let me know...

<?php /** * $Header: /repository/pear/Log/Log/console.php,v 1.19-r1 2004/01/19 08:02:40 jon Exp $ * * @version $Revision: 1.19-r1 $ * @package Log */ /** * The Log_console class is a concrete implementation of the Log:: * abstract class which writes message to the text console. * * @author Jon Parise <jon@php.net> * @since Log 1.1 * @package Log * * @example console.php Using the console handler. */ class Log_console extends Log { /** * Handle to the current output stream. * @var resource * @access private */ var $_stream; /** * Should the output be buffered or displayed immediately? * @var string * @access private */ var $_buffering = false; /** * String holding the buffered output. * @var string * @access private */ var $_buffer = ''; /** * String containing the format of a log line. * @var string * @access private */ var $_lineFormat = '%1$s %2$s [%3$s] %4$s'; /** * String containing the timestamp format. It will be passed directly to * strftime(). Note that the timestamp string will generated using the * current locale. * @var string * @access private */ var $_timeFormat = '%b %d %H:%M:%S'; /** * Hash that maps canonical format keys to position arguments for the * "line format" string. * @var array * @access private */ var $_formatMap = array('%{timestamp}' => '%1$s', '%{ident}' => '%2$s', '%{priority}' => '%3$s', '%{message}' => '%4$s', '%\{' => '%%{'); /** * Constructs a new Log_console object. * * @param string $name Ignored. * @param string $ident The identity string. * @param array $conf The configuration array. * @param int $level Log messages up to and including this level. * @access public */ function Log_console($name, $ident = '', $conf = array(), $level = PEAR_LOG_DEBUG) { $this->_id = md5(microtime()); $this->_ident = $ident; $this->_mask = Log::UPTO($level); if (empty($conf['stream'])) { $conf['stream'] = "php://stdout"; } // Open up our stream $this->_stream = fopen($conf['stream'], 'w'); if (isset($conf['buffering'])) { $this->_buffering = $conf['buffering']; } if (!empty($conf['lineFormat'])) { $this->_lineFormat = str_replace(array_keys($this->_formatMap), array_values($this->_formatMap), $conf['lineFormat']); } if (!empty($conf['timeFormat'])) { $this->_timeFormat = $conf['timeFormat']; } /* * If output buffering has been requested, we need to register a * shutdown function that will dump the buffer upon termination. */ if ($this->_buffering) { register_shutdown_function(array(&$this, '_Log_console')); } } /** * Destructor */ function _Log_console() { $this->flush(); fclose($this->_stream); } /** * Flushes all pending ("buffered") data to the output stream. * * @access public * @since Log 1.8.2 */ function flush() { /* * If output buffering is enabled, dump the contents of the buffer to * the output stream. */ if ($this->_buffering && (strlen($this->_buffer) > 0)) { fwrite($this->_stream, $this->_buffer); $this->_buffer = ''; } return fflush($this->_stream); } /** * Writes $message to the text console. Also, passes the message * along to any Log_observer instances that are observing this Log. * * @param mixed $message String or object containing the message to log. * @param string $priority The priority of the message. Valid * values are: PEAR_LOG_EMERG, PEAR_LOG_ALERT, * PEAR_LOG_CRIT, PEAR_LOG_ERR, PEAR_LOG_WARNING, * PEAR_LOG_NOTICE, PEAR_LOG_INFO, and PEAR_LOG_DEBUG. * @return boolean True on success or false on failure. * @access public */ function log($message, $priority = null) { /* If a priority hasn't been specified, use the default value. */ if ($priority === null) { $priority = $this->_priority; } /* Abort early if the priority is above the maximum logging level. */ if (!$this->_isMasked($priority)) { return false; } /* Extract the string representation of the message. */ $message = $this->_extractMessage($message); /* Build the string containing the complete log line. */ $line = sprintf($this->_lineFormat, strftime($this->_timeFormat), $this->_ident, $this->priorityToString($priority), $message) . "\n"; /* * If buffering is enabled, append this line to the output buffer. * Otherwise, print the line to the output stream immediately. */ if ($this->_buffering) { $this->_buffer .= $line; } else { fwrite($this->_stream, $line); } /* Notify observers about this log message. */ $this->_announce(array('priority' => $priority, 'message' => $message)); return true; } } ?>--- /usr/share/pear/Log/console.php 2005-04-23 04:29:03.136942680 +1000 +++ /usr/share/pear/Log/console_bugfix.php 2005-04-23 03:52:45.000000000 +1000 @@ -1,8 +1,8 @@ <?php /** - * $Header: /repository/pear/Log/Log/console.php,v 1.19 2004/01/19 08:02:40 jon Exp $ + * $Header: /repository/pear/Log/Log/console.php,v 1.19-r1 2004/01/19 08:02:40 jon Exp $ * - * @version $Revision: 1.19 $ + * @version $Revision: 1.19-r1 $ * @package Log */ @@ -23,7 +23,7 @@ * @var resource * @access private */ - var $_stream = STDOUT; + var $_stream; /** * Should the output be buffered or displayed immediately? @@ -83,10 +83,13 @@ $this->_ident = $ident; $this->_mask = Log::UPTO($level); - if (!empty($conf['stream'])) { - $this->_stream = $conf['stream']; + if (empty($conf['stream'])) { + $conf['stream'] = "php://stdout"; } + // Open up our stream + $this->_stream = fopen($conf['stream'], 'w'); + if (isset($conf['buffering'])) { $this->_buffering = $conf['buffering']; } @@ -116,6 +119,7 @@ function _Log_console() { $this->flush(); + fclose($this->_stream); } /** @@ -177,7 +181,7 @@ if ($this->_buffering) { $this->_buffer .= $line; } else { - fwrite($this->_stream, $line); + fwrite($this->_stream, $line); } /* Notify observers about this log message. */