* @since Log 1.7.0 * @package Log * * @example win.php Using the window handler. */ class Log_win extends Log { /** * The name of the output window. * @var string * @access private */ var $_name = 'LogWindow'; /** * The title of the output window. * @var string * @access private */ var $_title = 'Log Output Window'; /** * Mapping of log priorities to colors. * @var array * @access private */ var $_colors = array( PEAR_LOG_EMERG => 'red', PEAR_LOG_ALERT => 'orange', PEAR_LOG_CRIT => 'yellow', PEAR_LOG_ERR => 'green', PEAR_LOG_WARNING => 'blue', PEAR_LOG_NOTICE => 'indigo', PEAR_LOG_INFO => 'violet', PEAR_LOG_DEBUG => 'black' ); /** * String buffer that holds line that are pending output. * @var array * @access private */ var $_buffer = array(); /** * Constructs a new Log_win 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_win($name, $ident = '', $conf = array(), $level = PEAR_LOG_DEBUG) { $this->_id = md5(microtime()); $this->_name = $name; $this->_ident = $ident; $this->_mask = Log::UPTO($level); if (isset($conf['title'])) { $this->_title = $conf['title']; } if (isset($conf['colors']) && is_array($conf['colors'])) { $this->_colors = $conf['colors']; } register_shutdown_function(array(&$this, '_Log_win')); } /** * Destructor */ function _Log_win() { if ($this->_opened || (count($this->_buffer) > 0)) { $this->close(); } } /** * The first time open() is called, it will open a new browser window and * prepare it for output. * * This is implicitly called by log(), if necessary. * * @access public */ function open() { if (!$this->_opened) { $win = $this->_name; if (!empty($this->_ident)) { $identHeader = "$win.document.writeln('Ident')"; } else { $identHeader = ''; } echo <<< END_OF_SCRIPT END_OF_SCRIPT; $this->_opened = true; } return $this->_opened; } /** * Closes the output stream if it is open. If there are still pending * lines in the output buffer, the output window will be opened so that * the buffer can be drained. * * @access public */ function close() { /* * If there are still lines waiting to be written, open the output * window so that we can drain the buffer. */ if (!$this->_opened && (count($this->_buffer) > 0)) { $this->open(); } if ($this->_opened) { $this->_writeln(''); $this->_writeln(''); $this->_opened = false; } return ($this->_opened === false); } /** * Writes a single line of text to the output window. * * @param string $line The line of text to write. * * @access private */ function _writeln($line) { /* Add this line to our output buffer. */ $this->_buffer[] = $line; /* Buffer the output until this page's headers have been sent. */ if (!headers_sent()) { return; } /* If we haven't already opened the output window, do so now. */ if (!$this->_opened && !$this->open()) { return false; } /* Drain the buffer to the output window. */ $win = $this->_name; foreach ($this->_buffer as $line) { echo "\n"; } /* Now that the buffer has been drained, clear it. */ $this->_buffer = array(); } /** * Logs $message to the output window. The message is also passed 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); list($usec, $sec) = explode(' ', microtime()); /* Build the output line that contains the log entry row. */ $line = ''; $line .= sprintf('%s.%s', strftime('%T', $sec), substr($usec, 2, 2)); if (!empty($this->_ident)) { $line .= '' . $this->_ident . ''; } $line .= '' . ucfirst($this->priorityToString($priority)) . ''; $line .= sprintf('%s', $this->_colors[$priority], preg_replace('/\r\n|\n|\r/', '
', $message)); $line .= ''; $this->_writeln($line); $this->_announce(array('priority' => $priority, 'message' => $message)); return true; } }