diff -Nru php-log-1.9.11/debian/changelog php-log-1.9.16/debian/changelog --- php-log-1.9.11/debian/changelog 2008-02-09 03:43:36.000000000 +0100 +++ php-log-1.9.16/debian/changelog 2008-02-09 03:43:37.000000000 +0100 @@ -1,3 +1,18 @@ +php-log (1.9.16-1) unstable; urgency=low + + * New upstream release. + * Update to standards version 3.7.3, no further required changes. + * Update short description to have unform PEAR packaging. + * Migrate homepage to Homepage: field. + * Update description like in package.xml. + * Remove php-mdb2 from Suggests (php-mdb2 isn't in Debian). + * Add Vcs-* fields in debian/control. + * Move to team maintainership and update Uploaders. (Closes: #383010) + * Upgrade debian/rules to have unform PEAR packaging. + * Remove empty directory in debian/rules to fix lintian warning. + + -- Gregory Colpart (evolix) Fri, 08 Feb 2008 23:23:37 +0100 + php-log (1.9.11-1) unstable; urgency=low * New upstream release. (Closes: #417567) diff -Nru /tmp/7scurou5oz/php-log-1.9.11/debian/control /tmp/SnCcFixfIb/php-log-1.9.16/debian/control --- php-log-1.9.11/debian/control 2008-02-09 03:43:36.000000000 +0100 +++ php-log-1.9.16/debian/control 2008-02-09 03:43:37.000000000 +0100 @@ -1,21 +1,22 @@ Source: php-log Section: web Priority: optional -Maintainer: Jose Carlos Medeiros -Uploaders: Ola Lundqvist +Maintainer: Debian PHP Maintainers +Uploaders: Ola Lundqvist , Gregory Colpart (evolix) Build-Depends-Indep: php-pear Build-Depends: debhelper (>= 5) -Standards-Version: 3.7.2 +Standards-Version: 3.7.3 +Homepage: http://pear.php.net/package/Log/ +Vcs-Svn: svn://svn.debian.org/pkg-php/pear/php-log/trunk +Vcs-Browser: http://svn.debian.org/wsvn/pkg-php/pear/php-log/trunk Package: php-log Architecture: all Depends: php-pear -Suggests: php-db (>= 1.3), php5-sqlite, php-mdb2 +Suggests: php-db (>= 1.3), php5-sqlite Replaces: php4-pear-log (<= 1.9.3-1) Conflicts: php4-pear-log (<= 1.9.3-2) -Description: Log module for PEAR - The Log framework provides an abstracted logging system. It supports - logging to console, file, syslog, SQL, and mcal targets. It also provides - a subject - observer mechanism. - . - Homepage: http://pear.php.net/package/Log/ +Description: PHP PEAR modules for logging + The Log package provides an abstracted logging framework. It includes output + handlers for log files, databases, syslog, email, Firebug, and the console. + It also provides composite and subject-observer logging mechanisms. diff -Nru /tmp/7scurou5oz/php-log-1.9.11/debian/rules /tmp/SnCcFixfIb/php-log-1.9.16/debian/rules --- php-log-1.9.11/debian/rules 2008-02-09 03:43:36.000000000 +0100 +++ php-log-1.9.16/debian/rules 2008-02-09 03:43:37.000000000 +0100 @@ -5,6 +5,10 @@ # Uncomment this to turn on verbose mode. #export DH_VERBOSE=1 +DEB_VERSION := $(shell dpkg-parsechangelog | egrep '^Version:' | cut -f 2 -d ' ') +DEB_NOEPOCH_VERSION := $(shell echo $(DEB_VERSION) | cut -d: -f2-) +DEB_UPSTREAM_VERSION := $(shell echo $(DEB_NOEPOCH_VERSION) | sed 's/-[^-]*$$//') + PEAR ?= /usr/bin/pear pear_pkg = $(shell ls |grep Log) package = php-log @@ -36,7 +40,18 @@ # Add here commands to install the package into debian/package. cp package.xml $(pear_pkg)/package.xml; - $(PEAR) install -n -R debian/$(package) $(pear_pkg)/package.xml; + $(PEAR) \ + -c debian/pearrc \ + -d include_path=/usr/share/php \ + -d php_bin=/usr/bin/php \ + -d bin_dir=/usr/bin \ + -d php_dir=/usr/share/php \ + -d data_dir=/usr/share/php/data \ + -d doc_dir=/usr/share/php/docs \ + -d test_dir=/usr/share/php/tests \ + install -n -f -P debian/$(package) $(pear_pkg)/package.xml + + # remove unwanted files rm -f debian/$(package)/usr/share/php/.filemap; rm -f debian/$(package)/usr/share/php/.lock; rm -rf debian/$(package)/usr/share/php/.channels; @@ -44,21 +59,22 @@ rm -rf debian/$(package)/usr/share/php/.depdb; rm -rf debian/$(package)/usr/share/php/.registry/.channel.pecl.php.net; rm -rf debian/$(package)/usr/share/php/.registry/.channel.__uri; + rm -rf debian/$(package)/tmp # remove duplicated files, these files are in /usr/share/doc/package - rm -rf debian/$(package)/usr/share/php/docs; - rm -rf debian/$(package)/usr/share/php/tests; - rm -rf debian/$(package)/usr/share/php/data/Log/misc; - - # remove created tmp dir - rm -rf debian/$(package)/tmp + rm -rf debian/$(package)/usr/share/php/tests \ + debian/$(package)/usr/share/php/docs \ + debian/$(package)/usr/share/php/data/Log + + # remove empty directory (lintian warning) + rmdir debian/$(package)/usr/share/php/data + +# Build architecture-dependent files here. +binary-arch: build install +# We have nothing to do by default. # Build architecture-independent files here. binary-indep: build install -# We have nothing to do by default. - -# Build architecture-dependent files here. -binary-arch: build install dh_testdir dh_testroot dh_installdocs @@ -73,3 +89,8 @@ binary: binary-indep binary-arch .PHONY: build clean binary-indep binary-arch binary install configure + +get-orig-source: + wget http://download.pear.php.net/package/Log-${DEB_UPSTREAM_VERSION}.tgz \ + -O php-log_${DEB_UPSTREAM_VERSION}.orig.tar.gz + diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/composite.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/composite.php --- php-log-1.9.11/Log-1.9.11/docs/examples/composite.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/composite.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,12 +0,0 @@ -addChild($console); -$composite->addChild($file); - -$composite->log('This event will be logged to both handlers.'); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/console.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/console.php --- php-log-1.9.11/Log-1.9.11/docs/examples/console.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/console.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,8 +0,0 @@ -log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/display.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/display.php --- php-log-1.9.11/Log-1.9.11/docs/examples/display.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/display.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,10 +0,0 @@ - '', - 'error_append' => ''); -$logger = &Log::singleton('display', '', '', $conf, PEAR_LOG_DEBUG); -for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/error_log.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/error_log.php --- php-log-1.9.11/Log-1.9.11/docs/examples/error_log.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/error_log.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,8 +0,0 @@ -log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/file.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/file.php --- php-log-1.9.11/Log-1.9.11/docs/examples/file.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/file.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,9 +0,0 @@ - 0600, 'timeFormat' => '%X %x'); -$logger = &Log::singleton('file', 'out.log', 'ident', $conf); -for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/firebug.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/firebug.php --- php-log-1.9.11/Log-1.9.11/docs/examples/firebug.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/firebug.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,12 +0,0 @@ - true), - PEAR_LOG_DEBUG); - -for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/mail.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/mail.php --- php-log-1.9.11/Log-1.9.11/docs/examples/mail.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/mail.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,9 +0,0 @@ - 'Important Log Events'); -$logger = &Log::singleton('mail', 'webmaster@example.com', 'ident', $conf); -for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/null.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/null.php --- php-log-1.9.11/Log-1.9.11/docs/examples/null.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/null.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,8 +0,0 @@ -log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/observer_mail.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/observer_mail.php --- php-log-1.9.11/Log-1.9.11/docs/examples/observer_mail.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/observer_mail.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,30 +0,0 @@ -Log_observer($priority); - - /* Configure the observer. */ - $this->_to = $conf['to']; - $this->_subject = $conf['subject']; - $this->_pattern = $conf['pattern']; - } - - function notify($event) - { - if (preg_match($this->_pattern, $event['message']) != 0) { - mail($this->_to, $this->_subject, $event['message']); - } - } -} - -?> diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/pear_error_handler.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/pear_error_handler.php --- php-log-1.9.11/Log-1.9.11/docs/examples/pear_error_handler.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/pear_error_handler.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,25 +0,0 @@ -getMessage(); - - if (!empty($error->backtrace[1]['file'])) { - $message .= ' (' . $error->backtrace[1]['file']; - if (!empty($error->backtrace[1]['line'])) { - $message .= ' at line ' . $error->backtrace[1]['line']; - } - $message .= ')'; - } - - $logger->log($message, $error->code); -} - -$logger = &Log::singleton('console', '', 'ident'); - -PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'errorHandler'); -PEAR::raiseError('This is an information log message.', PEAR_LOG_INFO); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/php_error_handler.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/php_error_handler.php --- php-log-1.9.11/Log-1.9.11/docs/examples/php_error_handler.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/php_error_handler.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,34 +0,0 @@ -log($message . ' in ' . $file . ' at line ' . $line, - $priority); -} - -$logger = &Log::singleton('console', '', 'ident'); - -set_error_handler('errorHandler'); -trigger_error('This is an information log message.', E_USER_NOTICE); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/sqlite.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/sqlite.php --- php-log-1.9.11/Log-1.9.11/docs/examples/sqlite.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/sqlite.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,14 +0,0 @@ - 'log.db', 'mode' => 0666, 'persistent' => true); -$logger =& Log::factory('sqlite', 'log_table', 'ident', $conf); -$logger->log('logging an event', PEAR_LOG_WARNING); - -/* Using an existing database connection. */ -$db = sqlite_open('log.db', 0666, $error); -$logger =& Log::factory('sqlite', 'log_table', 'ident', $db); -$logger->log('logging an event', PEAR_LOG_WARNING); -sqlite_close($db); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/sql.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/sql.php --- php-log-1.9.11/Log-1.9.11/docs/examples/sql.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/sql.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,9 +0,0 @@ - 'pgsql://jon@localhost+unix/logs'); -$logger = &Log::singleton('sql', 'log_table', 'ident', $conf); -for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/syslog.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/syslog.php --- php-log-1.9.11/Log-1.9.11/docs/examples/syslog.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/syslog.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,8 +0,0 @@ -log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/examples/win.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/examples/win.php --- php-log-1.9.11/Log-1.9.11/docs/examples/win.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/examples/win.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,9 +0,0 @@ - 'Sample Log Output'); -$logger = &Log::singleton('win', 'LogWindow', 'ident', $conf); -for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/docs/guide.txt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/docs/guide.txt --- php-log-1.9.11/Log-1.9.11/docs/guide.txt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/docs/guide.txt 1970-01-01 01:00:00.000000000 +0100 @@ -1,1090 +0,0 @@ -================= - The Log Package -================= - --------------------- - User Documentation --------------------- - -:Author: Jon Parise -:Contact: jon@php.net -:Date: $Date: 2007/02/09 05:32:48 $ -:Revision: $Revision: 1.32 $ - -.. contents:: Contents -.. section-numbering:: - -Using Log Handlers -================== - -The Log package is implemented as a framework that supports the notion of -backend-specific log handlers. The base logging object (defined by the `Log -class`_) is primarily an abstract interface to the currently configured -handler. - -A wide variety of handlers are distributed with the Log package, and, should -none of them fit your application's needs, it's easy to `write your own`__. - -.. _Log class: http://cvs.php.net/co.php/pear/Log/Log.php -__ `Custom Handlers`_ - -Creating a Log Object ---------------------- -There are three ways to create Log objects: - - - Using the ``Log::factory()`` method - - Using the ``Log::singleton()`` method - - Direct instantiation - -The Factory Method -~~~~~~~~~~~~~~~~~~ -The ``Log::factory()`` method implements the `Factory Pattern`_. It allows -for the parameterized construction of concrete Log instances at runtime. The -first parameter to the ``Log::factory()`` method indicates the name of the -concrete handler to create. The rest of the parameters will be passed on to -the handler's constructor (see `Configuring a Handler`_ below). - -The new ``Log`` instance is returned by reference. - -:: - - require_once 'Log.php'; - - $console = &Log::factory('console', '', 'TEST'); - $console->log('Logging to the console.'); - - $file = &Log::factory('file', 'out.log', 'TEST'); - $file->log('Logging to out.log.'); - -.. _Factory Pattern: http://www.phppatterns.com/index.php/article/articleview/49/1/1/ - -The Singleton Method -~~~~~~~~~~~~~~~~~~~~ -The ``Log::singleton()`` method implements the `Singleton Pattern`_. The -singleton pattern ensures that only a single instance of a given log type and -configuration is ever created. This has two benefits: first, it prevents -duplicate ``Log`` instances from being constructed, and, second, it gives all -of your code access to the same ``Log`` instance. The latter is especially -important when logging to files because only a single file handler will need -to be managed. - -The ``Log::singleton()`` method's parameters match the ``Log::factory()`` -method. The new ``Log`` instance is returned by reference. - -:: - - require_once 'Log.php'; - - /* Same construction parameters */ - $a = &Log::singleton('console', '', 'TEST'); - $b = &Log::singleton('console', '', 'TEST'); - - if ($a === $b) { - echo '$a and $b point to the same Log instance.' . "\n"; - } - - /* Different construction parameters */ - $c = &Log::singleton('console', '', 'TEST1'); - $d = &Log::singleton('console', '', 'TEST2'); - - if ($c !== $d) { - echo '$c and $d point to different Log instances.' . "\n"; - } - -.. _Singleton Pattern: http://www.phppatterns.com/index.php/article/articleview/6/1/1/ - -Direct Instantiation -~~~~~~~~~~~~~~~~~~~~ -It is also possible to directly instantiate concrete ``Log`` handler -instances. However, this method is **not recommended** because it creates a -tighter coupling between your application code and the Log package than is -necessary. Use of `the factory method`_ or `the singleton method`_ is -preferred. - - -Configuring a Handler ---------------------- -A log handler's configuration is determined by the arguments used in its -construction. Here's an overview of those parameters:: - - /* Using the factory method ... */ - &Log::factory($handler, $name, $ident, $conf, $maxLevel); - - /* Using the singleton method ... */ - &Log::singleton($handler, $name, $ident, $conf, $maxLevel); - - /* Using direct instantiation ... */ - new Log_handler($name, $ident, $conf, $maxLevel); - -+---------------+-----------+-----------------------------------------------+ -| Parameter | Type | Description | -+===============+===========+===============================================+ -| ``$handler`` | String | The type of Log handler to construct. This | -| | | parameter is only available when `the factory | -| | | method`_ or `the singleton method`_ are used. | -+---------------+-----------+-----------------------------------------------+ -| ``$name`` | String | The name of the log resource to which the | -| | | events will be logged. The use of this value | -| | | is determined by the handler's implementation.| -| | | It defaults to an empty string. | -+---------------+-----------+-----------------------------------------------+ -| ``$ident`` | String | An identification string that will be included| -| | | in all log events logged by this handler. | -| | | This value defaults to an empty string and can| -| | | be changed at runtime using the ``setIdent()``| -| | | method. | -+---------------+-----------+-----------------------------------------------+ -| ``$conf`` | Array | Associative array of key-value pairs that are | -| | | used to specify any handler-specific settings.| -+---------------+-----------+-----------------------------------------------+ -| ``$level`` | Integer | Log messages up to and including this level. | -| | | This value defaults to ``PEAR_LOG_DEBUG``. | -| | | See `Log Levels`_ and `Log Level Masks`_. | -+---------------+-----------+-----------------------------------------------+ - - -Logging an Event ----------------- -Events are logged using the ``log()`` method:: - - $logger->log('Message', PEAR_LOG_NOTICE); - -The first argument contains the log event's message. Even though the event is -always logged as a string, it is possible to pass an object to the ``log()`` -method. If the object implements a ``getString()`` method, a ``toString()`` -method or Zend Engine 2's special ``__toString()`` casting method, it will be -used to determine the object's string representation. Otherwise, the -`serialized`_ form of the object will be logged. - -The second, optional argument specifies the log event's priority. See the -`Log Levels`_ table for the complete list of priorities. The default priority -is PEAR_LOG_INFO. - -The ``log()`` method will return ``true`` if the event was successfully -logged. - -"Shortcut" methods are also available for logging an event at a specific log -level. See the `Log Levels`_ table for the complete list. - -.. _serialized: http://www.php.net/serialize - - -Log Levels ----------- -This table is ordered by highest priority (``PEAR_LOG_EMERG``) to lowest -priority (``PEAR_LOG_DEBUG``). - -+-----------------------+---------------+-----------------------------------+ -| Level | Shortcut | Description | -+=======================+===============+===================================+ -| ``PEAR_LOG_EMERG`` | ``emerg()`` | System is unusable | -+-----------------------+---------------+-----------------------------------+ -| ``PEAR_LOG_ALERT`` | ``alert()`` | Immediate action required | -+-----------------------+---------------+-----------------------------------+ -| ``PEAR_LOG_CRIT`` | ``crit()`` | Critical conditions | -+-----------------------+---------------+-----------------------------------+ -| ``PEAR_LOG_ERR`` | ``err()`` | Error conditions | -+-----------------------+---------------+-----------------------------------+ -| ``PEAR_LOG_WARNING`` | ``warning()`` | Warning conditions | -+-----------------------+---------------+-----------------------------------+ -| ``PEAR_LOG_NOTICE`` | ``notice()`` | Normal but significant | -+-----------------------+---------------+-----------------------------------+ -| ``PEAR_LOG_INFO`` | ``info()`` | Informational | -+-----------------------+---------------+-----------------------------------+ -| ``PEAR_LOG_DEBUG`` | ``debug()`` | Debug-level messages | -+-----------------------+---------------+-----------------------------------+ - - -Log Level Masks ---------------- -Defining a log level mask allows you to include and/or exclude specific levels -of events from being logged. The ``$level`` construction parameter (see -`Configuring a Handler`_) uses this mechanism to exclude log events below a -certain priority, and it's possible to define more complex masks once the Log -object has been constructed. - -Each priority has a specific mask associated with it. To compute a priority's -mask, use the static ``Log::MASK()`` method:: - - $mask = Log::MASK(PEAR_LOG_INFO); - -To compute the mask for all priorities up to, and including, a certain level, -use the ``Log::MAX()`` static method:: - - $mask = Log::MAX(PEAR_LOG_INFO); - -To compute the mask for all priorities greater than or equal to a certain -level, use the ``Log::MIN()`` static method:: - - $mask = Log::MIN(PEAR_LOG_INFO); - -The apply the mask, use the ``setMask()`` method:: - - $logger->setMask($mask); - -Masks can be be combined using bitwise operations. To restrict logging to -only those events marked as ``PEAR_LOG_NOTICE`` or ``PEAR_LOG_DEBUG``:: - - $mask = Log::MASK(PEAR_LOG_NOTICE) | Log::MASK(PEAR_LOG_DEBUG); - $logger->setMask($mask); - -For convenience, two special masks are predefined: ``PEAR_LOG_NONE`` and -``PEAR_LOG_ALL``. ``PEAR_LOG_ALL`` is especially useful for exluding only -specific priorities:: - - $mask = PEAR_LOG_ALL ^ Log::MASK(PEAR_LOG_NOTICE); - $logger->setMask($mask); - -It is also possible to retrieve and modify a Log object's existing mask:: - - $mask = $logger->getMask() | Log::MASK(PEAR_LOG_INFO); - $logger->setMask($mask); - - -Flushing Log Events -------------------- -Some log handlers (such as `the console handler`_) support explicit -"buffering". When buffering is enabled, log events won't actually be written -to the output stream until the handler is closed. Other handlers (such as -`the file handler`_) support implicit buffering because they use the operating -system's IO routines, which may buffer the output. - -It's possible to force these handlers to flush their output, however, by -calling their ``flush()`` method:: - - $conf = array('buffering' => true); - $logger = &Log::singleton('console', '', 'test', $conf); - - for ($i = 0; $i < 10; $i++) { - $logger->log('This event will be buffered.'); - } - - /* Flush all of the buffered log events. */ - $logger->flush(); - - for ($i = 0; $i < 10; $i++) { - $logger->log('This event will be buffered.'); - } - - /* Implicitly flush the buffered events on close. */ - $logger->close(); - -At this time, the ``flush()`` method is only implemented by `the console -handler`_, `the file handler`_ and `the mail handler`_. - - -Standard Log Handlers -===================== - -The Console Handler -------------------- -The Console handler outputs log events directly to the console. It supports -output buffering and configurable string formats. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``stream`` | File | STDOUT_ | The output stream to use. | -+-------------------+-----------+---------------+---------------------------+ -| ``buffering`` | Boolean | False | Should the output be | -| | | | buffered until shutdown? | -+-------------------+-----------+---------------+---------------------------+ -| ``lineFormat`` | String | ``%1$s %2$s | Log line format | -| | | [%3$s] %4$s`` | specification. | -+-------------------+-----------+---------------+---------------------------+ -| ``timeFormat`` | String | ``%b %d | Time stamp format | -| | | %H:%M:%S`` | (for strftime_). | -+-------------------+-----------+---------------+---------------------------+ - -.. _STDOUT: http://www.php.net/wrappers.php -.. _strftime: http://www.php.net/strftime - -Example -~~~~~~~ -:: - - $logger = &Log::singleton('console', '', 'ident'); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The Display Handler -------------------- -The Display handler simply prints the log events back to the browser. It -respects the ``error_prepend_string`` and ``error_append_string`` `error -handling values`_ and is useful when `logging from standard error handlers`_. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``error_prepend`` | String | PHP INI value | This string will be | -| | | | prepended to the log | -| | | | output. | -+-------------------+-----------+---------------+---------------------------+ -| ``error_append`` | String | PHP INI value | This string will be | -| | | | appended to the log | -| | | | output. | -+-------------------+-----------+---------------+---------------------------+ -| ``linebreak`` | String | ``
\n`` | This string is used to | -| | | | represent a line break. | -+-------------------+-----------+---------------+---------------------------+ - -.. _error handling values: http://www.php.net/errorfunc - -Example -~~~~~~~ -:: - - $conf = array('error_prepend' => '', - 'error_append' => ''); - $logger = &Log::singleton('display', '', '', $conf, PEAR_LOG_DEBUG); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The Error_Log Handler ---------------------- -The Error_Log handler sends log events to PHP's `error_log()`_ function. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``destination`` | String | '' `(empty)` | Optional destination value| -| | | | for `error_log()`_. See | -| | | | `Error_Log Types`_ for | -| | | | more details. | -+-------------------+-----------+---------------+---------------------------+ -| ``extra_headers`` | String | '' `(empty)` | Additional headers to pass| -| | | | to the `mail()`_ function | -| | | | when the | -| | | | ``PEAR_LOG_TYPE_MAIL`` | -| | | | type is specified. | -+-------------------+-----------+---------------+---------------------------+ - -Error_Log Types -~~~~~~~~~~~~~~~ -All of the available log types are detailed in the `error_log()`_ section of -the PHP manual. For your convenience, the Log package also defines the -following constants that can be used for the ``$name`` handler construction -parameter. - -+---------------------------+-----------------------------------------------+ -| Constant | Description | -+===========================+===============================================+ -| ``PEAR_LOG_TYPE_SYSTEM`` | Log events are sent to PHP's system logger, | -| | which uses the operating system's logging | -| | mechanism or a file (depending on the value | -| | of the `error_log configuration directive`_). | -+---------------------------+-----------------------------------------------+ -| ``PEAR_LOG_TYPE_MAIL`` | Log events are sent via email to the address | -| | specified in the ``destination`` value. | -+---------------------------+-----------------------------------------------+ -| ``PEAR_LOG_TYPE_DEBUG`` | Log events are sent through PHP's debugging | -| | connection. This will only work if | -| | `remote debugging`_ has been enabled. The | -| | ``destination`` value is used to specify the | -| | host name or IP address of the target socket. | -+---------------------------+-----------------------------------------------+ -| ``PEAR_LOG_TYPE_FILE`` | Log events will be appended to the file named | -| | by the ``destination`` value. | -+---------------------------+-----------------------------------------------+ - -.. _error_log(): http://www.php.net/error_log -.. _mail(): http://www.php.net/mail -.. _error_log configuration directive: http://www.php.net/errorfunc#ini.error-log -.. _remote debugging: http://www.php.net/install.configure#install.configure.enable-debugger - -Example -~~~~~~~ -:: - - $logger = &Log::singleton('error_log', PEAR_LOG_TYPE_SYSTEM, 'ident'); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The File Handler ----------------- -The File handler writes log events to a text file using configurable string -formats. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``append`` | Boolean | True | Should new log entries be | -| | | | append to an existing log | -| | | | file, or should the a new | -| | | | log file overwrite an | -| | | | existing one? | -+-------------------+-----------+---------------+---------------------------+ -| ``locking`` | Boolean | False | Should advisory file | -| | | | locking (using flock_) be | -| | | | used? | -+-------------------+-----------+---------------+---------------------------+ -| ``mode`` | Integer | 0644 | Octal representation of | -| | | | the log file's permissions| -| | | | mode. | -+-------------------+-----------+---------------+---------------------------+ -| ``dirmode`` | Integer | 0755 | Octal representation of | -| | | | the file permission mode | -| | | | that will be used when | -| | | | creating directories that | -| | | | do not already exist. | -+-------------------+-----------+---------------+---------------------------+ -| ``eol`` | String | OS default | The end-on-line character | -| | | | sequence. | -+-------------------+-----------+---------------+---------------------------+ -| ``lineFormat`` | String | ``%1$s %2$s | Log line format | -| | | [%3$s] %4$s`` | specification. | -+-------------------+-----------+---------------+---------------------------+ -| ``timeFormat`` | String | ``%b %d | Time stamp format | -| | | %H:%M:%S`` | (for strftime_). | -+-------------------+-----------+---------------+---------------------------+ - -.. _flock: http://www.php.net/flock -.. _strftime: http://www.php.net/strftime - -The file handler will only attempt to set the ``mode`` value if it was -responsible for creating the file. - -Example -~~~~~~~ -:: - - $conf = array('mode' => 0600, 'timeFormat' => '%X %x'); - $logger = &Log::singleton('file', 'out.log', 'ident', $conf); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The Firebug Handler -------------------- -The Firebug handler outputs log events to the Firebug_ console. It supports -output buffering and configurable string formats. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``buffering`` | Boolean | False | Should the output be | -| | | | buffered until shutdown? | -+-------------------+-----------+---------------+---------------------------+ -| ``lineFormat`` | String | ``%2$s [%3$s] | Log line format | -| | | %4$s`` | specification. | -+-------------------+-----------+---------------+---------------------------+ -| ``timeFormat`` | String | ``%b %d | Time stamp format | -| | | %H:%M:%S`` | (for strftime_). | -+-------------------+-----------+---------------+---------------------------+ - -.. _Firebug: http://www.getfirebug.com/ -.. _strftime: http://www.php.net/strftime - -Example -~~~~~~~ -:: - - $logger = &Log::singleton('firebug', '', 'ident'); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The Mail Handler ----------------- -The Mail handler aggregates a session's log events and sends them in the body -of an email message using PHP's `mail()`_ function. - -Multiple recipients can be specified by separating their email addresses with -commas in the ``$name`` construction parameter. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``from`` | String | sendmail_from | Value for the message's | -| | | INI value | ``From:`` header. | -+-------------------+-----------+---------------+---------------------------+ -| ``subject`` | String | ``[Log_mail] | Value for the message's | -| | | Log message`` | ``Subject:`` header. | -+-------------------+-----------+---------------+---------------------------+ -| ``preamble`` | String | `` `(empty)` | Preamble for the message. | -+-------------------+-----------+---------------+---------------------------+ -| ``lineFormat`` | String | ``%1$s %2$s | Log line format | -| | | [%3$s] %4$s`` | specification. | -+-------------------+-----------+---------------+---------------------------+ -| ``timeFormat`` | String | ``%b %d | Time stamp format | -| | | %H:%M:%S`` | (for strftime_). | -+-------------------+-----------+---------------+---------------------------+ - -.. _mail(): http://www.php.net/mail - -Example -~~~~~~~ -:: - - $conf = array('subject' => 'Important Log Events'); - $logger = &Log::singleton('mail', 'webmaster@example.com', 'ident', $conf); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The MDB2 Handler ----------------- -The MDB2 handler is similar to `the SQL (DB) handler`_, but instead of using -the PEAR DB package, it uses the `MDB2 database abstraction package`_. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``dsn`` | Mixed | '' `(empty)` | A `Data Source Name`_. | -| | | | |required| | -+-------------------+-----------+---------------+---------------------------+ -| ``options`` | Array | ``persistent``| An array of `MDB2`_ | -| | | | options. | -+-------------------+-----------+---------------+---------------------------+ -| ``db`` | Object | NULL | An existing `MDB2`_ | -| | | | object. If specified, | -| | | | this object will be used, | -| | | | and ``dsn`` will be | -| | | | ignored. | -+-------------------+-----------+---------------+---------------------------+ -| ``sequence`` | String | ``log_id`` | The name of the sequence | -| | | | to use when generating | -| | | | unique event IDs. Under | -| | | | many databases, this will | -| | | | be used as the name of | -| | | | the sequence table. | -+-------------------+-----------+---------------+---------------------------+ -| ``identLimit`` | Integer | 16 | The maximum length of the | -| | | | ``ident`` string. | -| | | | **Changing this value may | -| | | | require updates to the SQL| -| | | | schema, as well.** | -+-------------------+-----------+---------------+---------------------------+ -| ``singleton`` | Boolean | false | Is true, use a singleton | -| | | | database object using | -| | | | `MDB2::singleton()`_. | -+-------------------+-----------+---------------+---------------------------+ - -.. _MDB2: http://pear.php.net/package/MDB2 -.. _MDB2 database abstraction package: MDB2_ -.. _MDB2::singleton(): http://pear.php.net/package/MDB2/docs/latest/MDB2/MDB2.html#methodsingleton - -The Null Handler ----------------- -The Null handler simply consumes log events (akin to sending them to -``/dev/null``). `Log level masks`_ are respected, and the event will still be -sent to any registered `log observers`_. - -Example -~~~~~~~ -:: - - $logger = &Log::singleton('null'); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The SQL (DB) Handler --------------------- - -The SQL handler sends log events to a database using `PEAR's DB abstraction -layer`_. - -**Note:** Due to the constraints of the default database schema, the SQL -handler limits the length of the ``$ident`` string to sixteen (16) characters. -This limit can be adjusted using the ``identLimit`` configuration parameter. - -The Log Table -~~~~~~~~~~~~~ -The default SQL table used by this handler looks like this:: - - CREATE TABLE log_table ( - id INT NOT NULL, - logtime TIMESTAMP NOT NULL, - ident CHAR(16) NOT NULL, - priority INT NOT NULL, - message VARCHAR(200), - PRIMARY KEY (id) - ); - -This is the "lowest common denominator" that should work across all SQL -compliant database. You may want to make database- or site-specific changes -to this schema to support your specific needs, however. For example, -`PostgreSQL`_ users may prefer to use a ``TEXT`` type for the ``message`` -field. - -.. _PostgreSQL: http://www.postgresql.org/ - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``dsn`` | Mixed | '' `(empty)` | A `Data Source Name`_. | -| | | | |required| | -+-------------------+-----------+---------------+---------------------------+ -| ``sql`` | String | |sql-default| | SQL insertion statement. | -+-------------------+-----------+---------------+---------------------------+ -| ``options`` | Array | ``persistent``| An array of `DB`_ options.| -+-------------------+-----------+---------------+---------------------------+ -| ``db`` | Object | NULL | An existing `DB`_ object. | -| | | | If specified, this object | -| | | | will be used, and ``dsn`` | -| | | | will be ignored. | -+-------------------+-----------+---------------+---------------------------+ -| ``sequence`` | String | ``log_id`` | The name of the sequence | -| | | | to use when generating | -| | | | unique event IDs. Under | -| | | | many databases, this will | -| | | | be used as the name of | -| | | | the sequence table. | -+-------------------+-----------+---------------+---------------------------+ -| ``identLimit`` | Integer | 16 | The maximum length of the | -| | | | ``ident`` string. | -| | | | **Changing this value may | -| | | | require updates to the SQL| -| | | | schema, as well.** | -+-------------------+-----------+---------------+---------------------------+ - -The name of the database table to which the log entries will be written is -specified using the ``$name`` construction parameter (see `Configuring a -Handler`_). - -.. |sql-default| replace:: ``INSERT INTO $table (id, logtime, ident, priority, message) VALUES(?, CURRENT_TIMESTAMP, ?, ?, ?)`` - -.. _DB: http://pear.php.net/package/DB -.. _PEAR's DB abstraction layer: DB_ -.. _Data Source Name: http://pear.php.net/manual/en/package.database.db.intro-dsn.php - -Examples -~~~~~~~~ -Using a `Data Source Name`_ to create a new database connection:: - - $conf = array('dsn' => 'pgsql://jon@localhost+unix/logs'); - $logger = &Log::singleton('sql', 'log_table', 'ident', $conf); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - -Using an existing `DB`_ object:: - - require_once 'DB.php'; - $db = &DB::connect('pgsql://jon@localhost+unix/logs'); - - $conf['db'] = $db; - $logger = &Log::singleton('sql', 'log_table', 'ident', $conf); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The Sqlite Handler ------------------- -:Author: Bertrand Mansion -:Contact: bmansion@mamasam.com - -The Sqlite handler sends log events to an Sqlite database using the `native -PHP sqlite functions`_. - -It is faster than `the SQL (DB) handler`_ because requests are made directly -to the database without using an abstraction layer. It is also interesting to -note that Sqlite database files can be moved, copied, and deleted on your -system just like any other files, which makes log management easier. Last but -not least, using a database to log your events allows you to use SQL queries -to create reports and statistics. - -When using a database and logging a lot of events, it is recommended to split -the database into smaller databases. This is allowed by Sqlite, and you can -later use the Sqlite `ATTACH`_ statement to query your log database files -globally. - -If the database does not exist when the log is opened, sqlite will try to -create it automatically. If the log table does not exist, it will also be -automatically created. The table creation uses the following SQL request:: - - CREATE TABLE log_table ( - id INTEGER PRIMARY KEY NOT NULL, - logtime NOT NULL, - ident CHAR(16) NOT NULL, - priority INT NOT NULL, - message - ); - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``filename`` | String | '' `(empty)` | Path to an Sqlite | -| | | | database. |required| | -+-------------------+-----------+---------------+---------------------------+ -| ``mode`` | Integer | 0666 | Octal mode used to open | -| | | | the database. | -+-------------------+-----------+---------------+---------------------------+ -| ``persistent`` | Boolean | false | Use a persistent | -| | | | connection. | -+-------------------+-----------+---------------+---------------------------+ - -An already opened database connection can also be passed as parameter instead -of the above configuration. In this case, closing the database connection is -up to the user. - -.. _native PHP sqlite functions: http://www.php.net/sqlite -.. _ATTACH: http://www.sqlite.org/lang.html#attach - -Examples -~~~~~~~~ -Using a configuration to create a new database connection:: - - $conf = array('filename' => 'log.db', 'mode' => 0666, 'persistent' => true); - $logger =& Log::factory('sqlite', 'log_table', 'ident', $conf); - $logger->log('logging an event', PEAR_LOG_WARNING); - -Using an existing connection:: - - $db = sqlite_open('log.db', 0666, $error); - $logger =& Log::factory('sqlite', 'log_table', 'ident', $db); - $logger->log('logging an event', PEAR_LOG_WARNING); - sqlite_close($db); - - -The Syslog Handler ------------------- -The Syslog handler sends log events to the system logging service (syslog on -Unix-like environments or the Event Log on Windows systems). The events are -sent using PHP's `syslog()`_ function. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``inherit`` | Boolean | false | Inherit the current syslog| -| | | | connection for this | -| | | | process, or start a new | -| | | | one via `openlog()`_? | -+-------------------+-----------+---------------+---------------------------+ - -Facilities -~~~~~~~~~~ -+-------------------+-------------------------------------------------------+ -| Constant | Category Description | -+===================+=======================================================+ -| ``LOG_AUTH`` | Security / authorization messages; ``LOG_AUTHPRIV`` is| -| | preferred on systems where it is defined. | -+-------------------+-------------------------------------------------------+ -| ``LOG_AUTHPRIV`` | Private security / authorization messages | -+-------------------+-------------------------------------------------------+ -| ``LOG_CRON`` | Clock daemon (``cron`` and ``at``) | -+-------------------+-------------------------------------------------------+ -| ``LOG_DAEMON`` | System daemon processes | -+-------------------+-------------------------------------------------------+ -| ``LOG_KERN`` | Kernel messages | -+-------------------+-------------------------------------------------------+ -| ``LOG_LOCAL0`` .. | Reserved for local use; **not** available under | -| ``LOG_LOCAL7`` | Windows. | -+-------------------+-------------------------------------------------------+ -| ``LOG_LPR`` | Printer subsystem | -+-------------------+-------------------------------------------------------+ -| ``LOG_MAIL`` | Mail subsystem | -+-------------------+-------------------------------------------------------+ -| ``LOG_NEWS`` | USENET news subsystem | -+-------------------+-------------------------------------------------------+ -| ``LOG_SYSLOG`` | Internal syslog messages | -+-------------------+-------------------------------------------------------+ -| ``LOG_USER`` | Generic user-level messages | -+-------------------+-------------------------------------------------------+ -| ``LOG_UUCP`` | UUCP subsystem | -+-------------------+-------------------------------------------------------+ - -.. _syslog(): http://www.php.net/syslog -.. _openlog(): http://www.php.net/openlog - -Example -~~~~~~~ -:: - - $logger = &Log::singleton('syslog', LOG_LOCAL0, 'ident'); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -The Window Handler ------------------- -The Window handler sends log events to a separate browser window. The -original idea for this handler was inspired by Craig Davis' Zend.com article -entitled `"JavaScript Power PHP Debugging"`_. - -Configuration -~~~~~~~~~~~~~ -+-------------------+-----------+---------------+---------------------------+ -| Parameter | Type | Default | Description | -+===================+===========+===============+===========================+ -| ``title`` | String | ``Log Output | The title of the output | -| | | Window`` | window. | -+-------------------+-----------+---------------+---------------------------+ -| ``styles`` | Array | `ROY G BIV`_ | Mapping of log priorities | -| | | (high to low) | to CSS styles. | -+-------------------+-----------+---------------+---------------------------+ - -.. _"JavaScript Power PHP Debugging": http://www.zend.com/zend/tut/tutorial-DebugLib.php -.. _ROY G BIV: http://www.cis.rit.edu/ - -Example -~~~~~~~ -:: - - $conf = array('title' => 'Sample Log Output'); - $logger = &Log::singleton('win', 'LogWindow', 'ident', $conf); - for ($i = 0; $i < 10; $i++) { - $logger->log("Log entry $i"); - } - - -Composite Handlers -================== -It is often useful to log events to multiple handlers. The Log package -provides a compositing system that marks this task trivial. - -Start by creating the individual log handlers:: - - $console = &Log::singleton('console', '', 'TEST'); - $file = &Log::singleton('file', 'out.log', 'TEST'); - -Then, construct a composite handler and add the individual handlers as -children of the composite:: - - $composite = &Log::singleton('composite'); - $composite->addChild($console); - $composite->addChild($file); - -The composite handler implements the standard ``Log`` interface so you can use -it just like any of the other handlers:: - - $composite->log('This event will be logged to both handlers.'); - -Children can be removed from the composite when they're not longer needed:: - - $composite->removeChild($file); - - -Log Observers -============= -Log observers provide an implementation of the `observer pattern`_. In the -content of the Log package, they provide a mechanism by which you can examine -(i.e. observe) each event as it is logged. This allows the implementation of -special behavior based on the contents of a log event. For example, the -observer code could send an alert email if a log event contained the string -``PANIC``. - -Creating a log observer involves implementing a subclass of the -``Log_observer`` class. The subclass must override the base class's -``notify()`` method. This method is passed a hash containing the event's -priority and event. The subclass's implementation is free to act upon this -information in any way it likes. - -Log observers are attached to ``Log`` instances via the ``attach()`` method:: - - $observer = &Log_observer::factory('yourType'); - $logger->attach($observer); - -Observers can be detached using the ``detach()`` method:: - - $logger->detach($observer); - -At this time, no concrete ``Log_observer`` implementations are distributed -with the Log package. - -.. _observer pattern: http://phppatterns.com/index.php/article/articleview/27/1/1/ - - -Logging From Standard Error Handlers -==================================== - -Logging PHP Errors ------------------- -PHP's default error handler can be overridden using the `set_error_handler()`_ -function. The custom error handling function can use a global Log instance to -log the PHP errors. - -**Note:** Fatal PHP errors cannot be handled by a custom error handler at this -time. - -:: - - function errorHandler($code, $message, $file, $line) - { - global $logger; - - /* Map the PHP error to a Log priority. */ - switch ($code) { - case E_WARNING: - case E_USER_WARNING: - $priority = PEAR_LOG_WARNING; - break; - case E_NOTICE: - case E_USER_NOTICE: - $priority = PEAR_LOG_NOTICE; - break; - case E_ERROR: - case E_USER_ERROR: - $priority = PEAR_LOG_ERR; - break; - default: - $priority = PEAR_LOG_INFO; - } - - $logger->log($message . ' in ' . $file . ' at line ' . $line, - $priority); - } - - set_error_handler('errorHandler'); - trigger_error('This is an information log message.', E_USER_NOTICE); - -.. _set_error_handler(): http://www.php.net/set_error_handler - -Logging PHP Assertions ----------------------- -PHP allows user-defined `assert()`_ callback handlers. The assertion callback -is configured using the `assert_options()`_ function. - -:: - - function assertCallback($file, $line, $message) - { - global $logger; - - $logger->log($message . ' in ' . $file . ' at line ' . $line, - PEAR_LOG_ALERT); - } - - assert_options(ASSERT_CALLBACK, 'assertCallback'); - assert(false); - -.. _assert(): http://www.php.net/assert -.. _assert_options(): http://www.php.net/assert_options - -Logging PHP Exceptions ----------------------- -PHP 5 and later support the concept of `exceptions`_. A custom exception -handler can be assigned using the `set_exception_handler()`_ function. - -:: - - function exceptionHandler($exception) - { - global $logger; - - $logger->log($exception->getMessage(), PEAR_LOG_ALERT); - } - - set_exception_handler('exceptionHandler'); - throw new Exception('Uncaught Exception'); - -.. _exceptions: http://www.php.net/exceptions -.. _set_exception_handler(): http://www.php.net/set_exception_handler - -Logging PEAR Errors -------------------- -The Log package can be used with `PEAR::setErrorHandling()`_'s -``PEAR_ERROR_CALLBACK`` mechanism by writing an error handling function that -uses a global Log instance. Here's an example:: - - function errorHandler($error) - { - global $logger; - - $message = $error->getMessage(); - - if (!empty($error->backtrace[1]['file'])) { - $message .= ' (' . $error->backtrace[1]['file']; - if (!empty($error->backtrace[1]['line'])) { - $message .= ' at line ' . $error->backtrace[1]['line']; - } - $message .= ')'; - } - - $logger->log($message, $error->code); - } - - PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'errorHandler'); - PEAR::raiseError('This is an information log message.', PEAR_LOG_INFO); - -.. _PEAR::setErrorHandling(): http://pear.php.net/manual/en/core.pear.pear.seterrorhandling.php - - -Custom Handlers -=============== -There are times when the standard handlers aren't a perfect match for your -needs. In those situations, the solution might be to write a custom handler. - -Using a Custom Handler ----------------------- -Using a custom Log handler is very simple. Once written (see `Writing New -Handlers`_ and `Extending Existing Handlers`_ below), you have the choice of -placing the file in your PEAR installation's main ``Log/`` directory (usually -something like ``/usr/local/lib/php/Log`` or ``C:\php\pear\Log``), where it -can be found and use by any PHP application on the system, or placing the file -somewhere in your application's local hierarchy and including it before the -the custom Log object is constructed. - -Method 1: Handler in the Standard Location -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -After copying the handler file to your PEAR installation's ``Log/`` directory, -simply treat the handler as if it were part of the standard distributed. If -your handler is named ``custom`` (and therefore implemented by a class named -``Log_custom``):: - - require_once 'Log.php'; - - $logger = &Log::factory('custom', '', 'CUSTOM'); - - -Method 2: Handler in a Custom Location -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you prefer storing your handler in your application's local hierarchy, -you'll need to include that file before you can create a Log instance based on -it. - -:: - - require_once 'Log.php'; - require_once 'LocalHandlers/custom.php'; - - $logger = &Log::factory('custom', '', 'CUSTOM'); - - -Writing New Handlers --------------------- - -TODO - -Extending Existing Handlers ---------------------------- - -TODO - - -.. |required| replace:: **[required]** - -.. vim: tabstop=4 shiftwidth=4 softtabstop=4 expandtab textwidth=78 ft=rst: diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/composite.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/composite.php --- php-log-1.9.11/Log-1.9.11/Log/composite.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/composite.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,231 +0,0 @@ - - * @author Jon Parise - * - * @since Horde 1.3 - * @since Log 1.0 - * @package Log - * - * @example composite.php Using the composite handler. - */ -class Log_composite extends Log -{ - /** - * Array holding all of the Log instances to which log events should be - * sent. - * - * @var array - * @access private - */ - var $_children = array(); - - - /** - * Constructs a new composite Log object. - * - * @param boolean $name This parameter is ignored. - * @param boolean $ident This parameter is ignored. - * @param boolean $conf This parameter is ignored. - * @param boolean $level This parameter is ignored. - * - * @access public - */ - function Log_composite($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_ident = $ident; - } - - /** - * Opens all of the child instances. - * - * @return True if all of the child instances were successfully opened. - * - * @access public - */ - function open() - { - /* Attempt to open each of our children. */ - $this->_opened = true; - foreach ($this->_children as $id => $child) { - $this->_opened &= $this->_children[$id]->open(); - } - - /* If all children were opened, return success. */ - return $this->_opened; - } - - /** - * Closes all of the child instances. - * - * @return True if all of the child instances were successfully closed. - * - * @access public - */ - function close() - { - /* Attempt to close each of our children. */ - $closed = true; - foreach ($this->_children as $id => $child) { - $closed &= $this->_children[$id]->close(); - } - - /* Track the _opened state for consistency. */ - $this->_opened = false; - - /* If all children were closed, return success. */ - return $closed; - } - - /** - * Flushes all child instances. It is assumed that all of the children - * have been successfully opened. - * - * @return True if all of the child instances were successfully flushed. - * - * @access public - * @since Log 1.8.2 - */ - function flush() - { - /* Attempt to flush each of our children. */ - $flushed = true; - foreach ($this->_children as $id => $child) { - $flushed &= $this->_children[$id]->flush(); - } - - /* If all children were flushed, return success. */ - return $flushed; - } - - /** - * Sends $message and $priority to each child of this composite. If the - * children aren't already open, they will be opened here. - * - * @param mixed $message String or object containing the message - * to log. - * @param string $priority (optional) 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 if the entry is successfully logged. - * - * @access public - */ - function log($message, $priority = null) - { - /* If a priority hasn't been specified, use the default value. */ - if ($priority === null) { - $priority = $this->_priority; - } - - /* - * If the handlers haven't been opened, attempt to open them now. - * However, we don't treat failure to open all of the handlers as a - * fatal error. We defer that consideration to the success of calling - * each handler's log() method below. - */ - if (!$this->_opened) { - $this->open(); - } - - /* Attempt to log the event using each of the children. */ - $success = true; - foreach ($this->_children as $id => $child) { - $success &= $this->_children[$id]->log($message, $priority); - } - - $this->_announce(array('priority' => $priority, 'message' => $message)); - - /* Return success if all of the children logged the event. */ - return $success; - } - - /** - * Returns true if this is a composite. - * - * @return boolean True if this is a composite class. - * - * @access public - */ - function isComposite() - { - return true; - } - - /** - * Sets this identification string for all of this composite's children. - * - * @param string $ident The new identification string. - * - * @access public - * @since Log 1.6.7 - */ - function setIdent($ident) - { - /* Call our base class's setIdent() method. */ - parent::setIdent($ident); - - /* ... and then call setIdent() on all of our children. */ - foreach ($this->_children as $id => $child) { - $this->_children[$id]->setIdent($ident); - } - } - - /** - * Adds a Log instance to the list of children. - * - * @param object $child The Log instance to add. - * - * @return boolean True if the Log instance was successfully added. - * - * @access public - */ - function addChild(&$child) - { - /* Make sure this is a Log instance. */ - if (!is_a($child, 'Log')) { - return false; - } - - $this->_children[$child->_id] = &$child; - - return true; - } - - /** - * Removes a Log instance from the list of children. - * - * @param object $child The Log instance to remove. - * - * @return boolean True if the Log instance was successfully removed. - * - * @access public - */ - function removeChild($child) - { - if (!is_a($child, 'Log') || !isset($this->_children[$child->_id])) { - return false; - } - - unset($this->_children[$child->_id]); - - return true; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/console.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/console.php --- php-log-1.9.11/Log-1.9.11/Log/console.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/console.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,208 +0,0 @@ - - * @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 = STDOUT; - - /** - * 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'; - - /** - * 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'])) { - $this->_stream = $conf['stream']; - } - - 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->close(); - } - - /** - * Open the output stream. - * - * @access public - * @since Log 1.9.7 - */ - function open() - { - $this->_opened = true; - return true; - } - - /** - * Closes the output stream. - * - * This results in a call to flush(). - * - * @access public - * @since Log 1.9.0 - */ - function close() - { - $this->flush(); - $this->_opened = false; - return true; - } - - /** - * 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 = ''; - } - - if (is_resource($this->_stream)) { - return fflush($this->_stream); - } - - return false; - } - - /** - * 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 = $this->_format($this->_lineFormat, - strftime($this->_timeFormat), - $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; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/daemon.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/daemon.php --- php-log-1.9.11/Log-1.9.11/Log/daemon.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/daemon.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,230 +0,0 @@ - - * @version $Revision: 1.2 $ - * @package Log - */ -class Log_daemon extends Log -{ - /** - * Integer holding the log facility to use. - * @var string - */ - var $_name = LOG_DAEMON; - - /** - * Var holding the resource pointer to the socket - * @var resource - */ - var $_socket; - - /** - * The ip address or servername - * @see http://www.php.net/manual/en/transports.php - * @var string - */ - var $_ip = '127.0.0.1'; - - /** - * Protocol to use (tcp, udp, etc.) - * @see http://www.php.net/manual/en/transports.php - * @var string - */ - var $_proto = 'udp'; - - /** - * Port to connect to - * @var int - */ - var $_port = 514; - - /** - * Maximum message length in bytes - * @var int - */ - var $_maxsize = 4096; - - /** - * Socket timeout in seconds - * @var int - */ - var $_timeout = 1; - - - /** - * Constructs a new syslog object. - * - * @param string $name The syslog facility. - * @param string $ident The identity string. - * @param array $conf The configuration array. - * @param int $maxLevel Maximum level at which to log. - * @access public - */ - function Log_daemon($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - /* Ensure we have a valid integer value for $name. */ - if (empty($name) || !is_int($name)) { - $name = LOG_SYSLOG; - } - - $this->_id = md5(microtime()); - $this->_name = $name; - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - - if (isset($conf['ip'])) { - $this->_ip = $conf['ip']; - } - if (isset($conf['proto'])) { - $this->_proto = $conf['proto']; - } - if (isset($conf['port'])) { - $this->_port = $conf['port']; - } - if (isset($conf['maxsize'])) { - $this->_maxsize = $conf['maxsize']; - } - if (isset($conf['timeout'])) { - $this->_timeout = $conf['timeout']; - } - $this->_proto = $this->_proto . '://'; - - register_shutdown_function(array(&$this, '_Log_daemon')); - } - - /** - * Destructor. - * - * @access private - */ - function _Log_daemon() - { - $this->close(); - } - - /** - * Opens a connection to the system logger, if it has not already - * been opened. This is implicitly called by log(), if necessary. - * @access public - */ - function open() - { - if (!$this->_opened) { - $this->_opened = (bool)($this->_socket = @fsockopen( - $this->_proto . $this->_ip, - $this->_port, - $errno, - $errstr, - $this->_timeout)); - } - return $this->_opened; - } - - /** - * Closes the connection to the system logger, if it is open. - * @access public - */ - function close() - { - if ($this->_opened) { - $this->_opened = false; - return fclose($this->_socket); - } - return true; - } - - /** - * Sends $message to the currently open syslog connection. Calls - * open() if necessary. Also passes the message along to any Log_observer - * instances that are observing this Log. - * - * @param string $message The textual message to be logged. - * @param int $priority (optional) The priority of the message. Valid - * values are: LOG_EMERG, LOG_ALERT, LOG_CRIT, - * LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, - * and LOG_DEBUG. The default is LOG_INFO. - * @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; - } - - /* If the connection isn't open and can't be opened, return failure. */ - if (!$this->_opened && !$this->open()) { - return false; - } - - /* Extract the string representation of the message. */ - $message = $this->_extractMessage($message); - - /* Set the facility level. */ - $facility_level = intval($this->_name) + - intval($this->_toSyslog($priority)); - - /* Prepend ident info. */ - if (!empty($this->_ident)) { - $message = $this->_ident . ' ' . $message; - } - - /* Check for message length. */ - if (strlen($message) > $this->_maxsize) { - $message = substr($message, 0, ($this->_maxsize) - 10) . ' [...]'; - } - - /* Write to socket. */ - fwrite($this->_socket, '<' . $facility_level . '>' . $message . "\n"); - - $this->_announce(array('priority' => $priority, 'message' => $message)); - } - - /** - * Converts a PEAR_LOG_* constant into a syslog LOG_* constant. - * - * This function exists because, under Windows, not all of the LOG_* - * constants have unique values. Instead, the PEAR_LOG_* were introduced - * for global use, with the conversion to the LOG_* constants kept local to - * to the syslog driver. - * - * @param int $priority PEAR_LOG_* value to convert to LOG_* value. - * - * @return The LOG_* representation of $priority. - * - * @access private - */ - function _toSyslog($priority) - { - static $priorities = array( - PEAR_LOG_EMERG => LOG_EMERG, - PEAR_LOG_ALERT => LOG_ALERT, - PEAR_LOG_CRIT => LOG_CRIT, - PEAR_LOG_ERR => LOG_ERR, - PEAR_LOG_WARNING => LOG_WARNING, - PEAR_LOG_NOTICE => LOG_NOTICE, - PEAR_LOG_INFO => LOG_INFO, - PEAR_LOG_DEBUG => LOG_DEBUG - ); - - /* If we're passed an unknown priority, default to LOG_INFO. */ - if (!is_int($priority) || !in_array($priority, $priorities)) { - return LOG_INFO; - } - - return $priorities[$priority]; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/display.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/display.php --- php-log-1.9.11/Log-1.9.11/Log/display.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/display.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,141 +0,0 @@ - - * @since Log 1.8.0 - * @package Log - * - * @example display.php Using the display handler. - */ -class Log_display extends Log -{ - /** - * String to output before an error message - * @var string - * @access private - */ - var $_error_prepend = ''; - - /** - * String to output after an error message - * @var string - * @access private - */ - var $_error_append = ''; - - /** - * String used to represent a line break. - * @var string - * @access private - */ - var $_linebreak = "
\n"; - - /** - * Constructs a new Log_display 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_display($name = '', $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - - if (isset($conf['error_prepend'])) { - $this->_error_prepend = $conf['error_prepend']; - } else { - $this->_error_prepend = ini_get('error_prepend_string'); - } - - if (isset($conf['error_append'])) { - $this->_error_append = $conf['error_append']; - } else { - $this->_error_append = ini_get('error_append_string'); - } - - if (isset($conf['linebreak'])) { - $this->_linebreak = $conf['linebreak']; - } - } - - /** - * Opens the display handler. - * - * @access public - * @since Log 1.9.6 - */ - function open() - { - $this->_opened = true; - return true; - } - - /** - * Closes the display handler. - * - * @access public - * @since Log 1.9.6 - */ - function close() - { - $this->_opened = false; - return true; - } - - /** - * Writes $message to the text browser. 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 and output the complete log line. */ - echo $this->_error_prepend . - '' . ucfirst($this->priorityToString($priority)) . ': '. - nl2br(htmlspecialchars($message)) . - $this->_error_append . $this->_linebreak; - - /* Notify observers about this log message. */ - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/error_log.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/error_log.php --- php-log-1.9.11/Log-1.9.11/Log/error_log.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/error_log.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,127 +0,0 @@ - - * @since Log 1.7.0 - * @package Log - * - * @example error_log.php Using the error_log handler. - */ -class Log_error_log extends Log -{ - /** - * The error_log() log type. - * @var integer - * @access private - */ - var $_type = PEAR_LOG_TYPE_SYSTEM; - - /** - * The type-specific destination value. - * @var string - * @access private - */ - var $_destination = ''; - - /** - * Additional headers to pass to the mail() function when the - * PEAR_LOG_TYPE_MAIL type is used. - * @var string - * @access private - */ - var $_extra_headers = ''; - - /** - * Constructs a new Log_error_log 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_error_log($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_type = $name; - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - - if (!empty($conf['destination'])) { - $this->_destination = $conf['destination']; - } - if (!empty($conf['extra_headers'])) { - $this->_extra_headers = $conf['extra_headers']; - } - } - - /** - * Opens the handler. - * - * @access public - * @since Log 1.9.6 - */ - function open() - { - $this->_opened = true; - return true; - } - - /** - * Closes the handler. - * - * @access public - * @since Log 1.9.6 - */ - function close() - { - $this->_opened = false; - return true; - } - - /** - * Logs $message using PHP's error_log() function. 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); - - $success = error_log($this->_ident . ': ' . $message, $this->_type, - $this->_destination, $this->_extra_headers); - - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return $success; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/file.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/file.php --- php-log-1.9.11/Log-1.9.11/Log/file.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/file.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,316 +0,0 @@ - - * @author Roman Neuhauser - * @since Log 1.0 - * @package Log - * - * @example file.php Using the file handler. - */ -class Log_file extends Log -{ - /** - * String containing the name of the log file. - * @var string - * @access private - */ - var $_filename = 'php.log'; - - /** - * Handle to the log file. - * @var resource - * @access private - */ - var $_fp = false; - - /** - * Should new log entries be append to an existing log file, or should the - * a new log file overwrite an existing one? - * @var boolean - * @access private - */ - var $_append = true; - - /** - * Should advisory file locking (i.e., flock()) be used? - * @var boolean - * @access private - */ - var $_locking = false; - - /** - * Integer (in octal) containing the log file's permissions mode. - * @var integer - * @access private - */ - var $_mode = 0644; - - /** - * Integer (in octal) specifying the file permission mode that will be - * used when creating directories that do not already exist. - * @var integer - * @access private - */ - var $_dirmode = 0755; - - /** - * 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'; - - /** - * String containing the end-on-line character sequence. - * @var string - * @access private - */ - var $_eol = "\n"; - - /** - * Constructs a new Log_file 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_file($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_filename = $name; - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - - if (isset($conf['append'])) { - $this->_append = $conf['append']; - } - - if (isset($conf['locking'])) { - $this->_locking = $conf['locking']; - } - - if (!empty($conf['mode'])) { - if (is_string($conf['mode'])) { - $this->_mode = octdec($conf['mode']); - } else { - $this->_mode = $conf['mode']; - } - } - - if (!empty($conf['dirmode'])) { - if (is_string($conf['dirmode'])) { - $this->_dirmode = octdec($conf['dirmode']); - } else { - $this->_dirmode = $conf['dirmode']; - } - } - - 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 (!empty($conf['eol'])) { - $this->_eol = $conf['eol']; - } else { - $this->_eol = (strstr(PHP_OS, 'WIN')) ? "\r\n" : "\n"; - } - - register_shutdown_function(array(&$this, '_Log_file')); - } - - /** - * Destructor - */ - function _Log_file() - { - if ($this->_opened) { - $this->close(); - } - } - - /** - * Creates the given directory path. If the parent directories don't - * already exist, they will be created, too. - * - * This implementation is inspired by Python's os.makedirs function. - * - * @param string $path The full directory path to create. - * @param integer $mode The permissions mode with which the - * directories will be created. - * - * @return True if the full path is successfully created or already - * exists. - * - * @access private - */ - function _mkpath($path, $mode = 0700) - { - /* Separate the last pathname component from the rest of the path. */ - $head = dirname($path); - $tail = basename($path); - - /* Make sure we've split the path into two complete components. */ - if (empty($tail)) { - $head = dirname($path); - $tail = basename($path); - } - - /* Recurse up the path if our current segment does not exist. */ - if (!empty($head) && !empty($tail) && !is_dir($head)) { - $this->_mkpath($head, $mode); - } - - /* Create this segment of the path. */ - return @mkdir($head, $mode); - } - - /** - * Opens the log file for output. If the specified log file does not - * already exist, it will be created. By default, new log entries are - * appended to the end of the log file. - * - * This is implicitly called by log(), if necessary. - * - * @access public - */ - function open() - { - if (!$this->_opened) { - /* If the log file's directory doesn't exist, create it. */ - if (!is_dir(dirname($this->_filename))) { - $this->_mkpath($this->_filename, $this->_dirmode); - } - - /* Determine whether the log file needs to be created. */ - $creating = !file_exists($this->_filename); - - /* Obtain a handle to the log file. */ - $this->_fp = fopen($this->_filename, ($this->_append) ? 'a' : 'w'); - - /* We consider the file "opened" if we have a valid file pointer. */ - $this->_opened = ($this->_fp !== false); - - /* Attempt to set the file's permissions if we just created it. */ - if ($creating && $this->_opened) { - chmod($this->_filename, $this->_mode); - } - } - - return $this->_opened; - } - - /** - * Closes the log file if it is open. - * - * @access public - */ - function close() - { - /* If the log file is open, close it. */ - if ($this->_opened && fclose($this->_fp)) { - $this->_opened = false; - } - - return ($this->_opened === false); - } - - /** - * Flushes all pending data to the file handle. - * - * @access public - * @since Log 1.8.2 - */ - function flush() - { - if (is_resource($this->_fp)) { - return fflush($this->_fp); - } - - return false; - } - - /** - * 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; - } - - /* If the log file isn't already open, open it now. */ - if (!$this->_opened && !$this->open()) { - return false; - } - - /* Extract the string representation of the message. */ - $message = $this->_extractMessage($message); - - /* Build the string containing the complete log line. */ - $line = $this->_format($this->_lineFormat, - strftime($this->_timeFormat), - $priority, $message) . $this->_eol; - - /* If locking is enabled, acquire an exclusive lock on the file. */ - if ($this->_locking) { - flock($this->_fp, LOCK_EX); - } - - /* Write the log line to the log file. */ - $success = (fwrite($this->_fp, $line) !== false); - - /* Unlock the file now that we're finished writing to it. */ - if ($this->_locking) { - flock($this->_fp, LOCK_UN); - } - - /* Notify observers about this log message. */ - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return $success; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/firebug.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/firebug.php --- php-log-1.9.11/Log-1.9.11/Log/firebug.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/firebug.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,210 +0,0 @@ - - * @since Log 1.x.x - * @package Log - * - * @example firebug.php Using the firebug handler. - */ -class Log_firebug extends Log -{ - /** - * 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 = array(); - - /** - * String containing the format of a log line. - * @var string - * @access private - */ - var $_lineFormat = '%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. - * - * Note! Default lineFormat of this driver does not display time. - * - * @var string - * @access private - */ - var $_timeFormat = '%b %d %H:%M:%S'; - - /** - * Mapping of log priorities to Firebug methods. - * @var array - * @access private - */ - var $_methods = array( - PEAR_LOG_EMERG => 'error', - PEAR_LOG_ALERT => 'error', - PEAR_LOG_CRIT => 'error', - PEAR_LOG_ERR => 'error', - PEAR_LOG_WARNING => 'warn', - PEAR_LOG_NOTICE => 'info', - PEAR_LOG_INFO => 'info', - PEAR_LOG_DEBUG => 'debug' - ); - - /** - * Constructs a new Log_firebug 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_firebug($name = '', $ident = 'PHP', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - if (isset($conf['buffering'])) { - $this->_buffering = $conf['buffering']; - } - - if ($this->_buffering) { - register_shutdown_function(array(&$this, '_Log_firebug')); - } - - 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']; - } - } - - /** - * Opens the firebug handler. - * - * @access public - */ - function open() - { - $this->_opened = true; - return true; - } - - /** - * Destructor - */ - function _Log_firebug() - { - $this->close(); - } - - /** - * Closes the firebug handler. - * - * @access public - */ - function close() - { - $this->flush(); - $this->_opened = false; - return true; - } - - /** - * Flushes all pending ("buffered") data. - * - * @access public - */ - function flush() { - if (count($this->_buffer)) { - print '\n"; - }; - $this->_buffer = array(); - } - - /** - * Writes $message to Firebug 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); - $method = $this->_methods[$priority]; - - /* normalize line breaks */ - $message = str_replace("\r\n", "\n", $message); - - /* escape line breaks */ - $message = str_replace("\n", "\\n\\\n", $message); - - /* escape quotes */ - $message = str_replace('"', '\\"', $message); - - /* Build the string containing the complete log line. */ - $line = $this->_format($this->_lineFormat, - strftime($this->_timeFormat), - $priority, - $message); - - if ($this->_buffering) { - $this->_buffer[] = sprintf('console.%s("%s");', $method, $line); - } else { - print '\n"; - } - /* Notify observers about this log message. */ - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/mail.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/mail.php --- php-log-1.9.11/Log-1.9.11/Log/mail.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/mail.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,257 +0,0 @@ - - * @author Jon Parise - * @since Log 1.3 - * @package Log - * - * @example mail.php Using the mail handler. - */ -class Log_mail extends Log -{ - /** - * String holding the recipients' email addresses. Multiple addresses - * should be separated with commas. - * @var string - * @access private - */ - var $_recipients = ''; - - /** - * String holding the sender's email address. - * @var string - * @access private - */ - var $_from = ''; - - /** - * String holding the email's subject. - * @var string - * @access private - */ - var $_subject = '[Log_mail] Log message'; - - /** - * String holding an optional preamble for the log messages. - * @var string - * @access private - */ - var $_preamble = ''; - - /** - * 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'; - - /** - * String holding the mail message body. - * @var string - * @access private - */ - var $_message = ''; - - /** - * Flag used to indicated that log lines have been written to the message - * body and the message should be sent on close(). - * @var boolean - * @access private - */ - var $_shouldSend = false; - - /** - * Constructs a new Log_mail object. - * - * Here is how you can customize the mail driver with the conf[] hash : - * $conf['from'] : the mail's "From" header line, - * $conf['subject'] : the mail's "Subject" line. - * - * @param string $name The message's recipients. - * @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_mail($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_recipients = $name; - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - - if (!empty($conf['from'])) { - $this->_from = $conf['from']; - } else { - $this->_from = ini_get('sendmail_from'); - } - - if (!empty($conf['subject'])) { - $this->_subject = $conf['subject']; - } - - if (!empty($conf['preamble'])) { - $this->_preamble = $conf['preamble']; - } - - 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']; - } - - /* register the destructor */ - register_shutdown_function(array(&$this, '_Log_mail')); - } - - /** - * Destructor. Calls close(). - * - * @access private - */ - function _Log_mail() - { - $this->close(); - } - - /** - * Starts a new mail message. - * This is implicitly called by log(), if necessary. - * - * @access public - */ - function open() - { - if (!$this->_opened) { - if (!empty($this->_preamble)) { - $this->_message = $this->_preamble . "\r\n\r\n"; - } - $this->_opened = true; - $_shouldSend = false; - } - - return $this->_opened; - } - - /** - * Closes the message, if it is open, and sends the mail. - * This is implicitly called by the destructor, if necessary. - * - * @access public - */ - function close() - { - if ($this->_opened) { - if ($this->_shouldSend && !empty($this->_message)) { - $headers = "From: $this->_from\r\n"; - $headers .= "User-Agent: Log_mail"; - - if (mail($this->_recipients, $this->_subject, $this->_message, - $headers) == false) { - error_log("Log_mail: Failure executing mail()", 0); - return false; - } - - /* Clear the message string now that the email has been sent. */ - $this->_message = ''; - $this->_shouldSend = false; - } - $this->_opened = false; - } - - return ($this->_opened === false); - } - - /** - * Flushes the log output by forcing the email message to be sent now. - * Events that are logged after flush() is called will be appended to a - * new email message. - * - * @access public - * @since Log 1.8.2 - */ - function flush() - { - /* - * It's sufficient to simply call close() to flush the output. - * The next call to log() will cause the handler to be reopened. - */ - return $this->close(); - } - - /** - * Writes $message to the currently open mail message. - * Calls open(), if necessary. - * - * @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; - } - - /* If the message isn't open and can't be opened, return failure. */ - if (!$this->_opened && !$this->open()) { - return false; - } - - /* Extract the string representation of the message. */ - $message = $this->_extractMessage($message); - - /* Append the string containing the complete log line. */ - $this->_message .= $this->_format($this->_lineFormat, - strftime($this->_timeFormat), - $priority, $message) . "\r\n"; - $this->_shouldSend = true; - - /* Notify observers about this log message. */ - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/mcal.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/mcal.php --- php-log-1.9.11/Log-1.9.11/Log/mcal.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/mcal.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,170 +0,0 @@ - - * @since Horde 1.3 - * @since Log 1.0 - * @package Log - */ -class Log_mcal extends Log -{ - /** - * holding the calendar specification to connect to. - * @var string - * @access private - */ - var $_calendar = '{localhost/mstore}'; - - /** - * holding the username to use. - * @var string - * @access private - */ - var $_username = ''; - - /** - * holding the password to use. - * @var string - * @access private - */ - var $_password = ''; - - /** - * holding the options to pass to the calendar stream. - * @var integer - * @access private - */ - var $_options = 0; - - /** - * ResourceID of the MCAL stream. - * @var string - * @access private - */ - var $_stream = ''; - - /** - * Integer holding the log facility to use. - * @var string - * @access private - */ - var $_name = LOG_SYSLOG; - - - /** - * Constructs a new Log_mcal object. - * - * @param string $name The category to use for our events. - * @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_mcal($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_name = $name; - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - $this->_calendar = $conf['calendar']; - $this->_username = $conf['username']; - $this->_password = $conf['password']; - $this->_options = $conf['options']; - } - - /** - * Opens a calendar stream, if it has not already been - * opened. This is implicitly called by log(), if necessary. - * @access public - */ - function open() - { - if (!$this->_opened) { - $this->_stream = mcal_open($this->_calendar, $this->_username, - $this->_password, $this->_options); - $this->_opened = true; - } - - return $this->_opened; - } - - /** - * Closes the calendar stream, if it is open. - * @access public - */ - function close() - { - if ($this->_opened) { - mcal_close($this->_stream); - $this->_opened = false; - } - - return ($this->_opened === false); - } - - /** - * Logs $message and associated information to the currently open - * calendar stream. Calls open() if necessary. 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; - } - - /* If the connection isn't open and can't be opened, return failure. */ - if (!$this->_opened && !$this->open()) { - return false; - } - - /* Extract the string representation of the message. */ - $message = $this->_extractMessage($message); - - $date_str = date('Y:n:j:G:i:s'); - $dates = explode(':', $date_str); - - mcal_event_init($this->_stream); - mcal_event_set_title($this->_stream, $this->_ident); - mcal_event_set_category($this->_stream, $this->_name); - mcal_event_set_description($this->_stream, $message); - mcal_event_add_attribute($this->_stream, 'priority', $priority); - mcal_event_set_start($this->_stream, $dates[0], $dates[1], $dates[2], - $dates[3], $dates[4], $dates[5]); - mcal_event_set_end($this->_stream, $dates[0], $dates[1], $dates[2], - $dates[3], $dates[4], $dates[5]); - mcal_append_event($this->_stream); - - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/mdb2.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/mdb2.php --- php-log-1.9.11/Log-1.9.11/Log/mdb2.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/mdb2.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,358 +0,0 @@ - - * @author Jon Parise - * @since Log 1.9.0 - * @package Log - */ -class Log_mdb2 extends Log -{ - /** - * Variable containing the DSN information. - * @var mixed - * @access private - */ - var $_dsn = ''; - - /** - * Array containing our set of DB configuration options. - * @var array - * @access private - */ - var $_options = array('persistent' => true); - - /** - * Object holding the database handle. - * @var object - * @access private - */ - var $_db = null; - - /** - * Resource holding the prepared statement handle. - * @var resource - * @access private - */ - var $_statement = null; - - /** - * Flag indicating that we're using an existing database connection. - * @var boolean - * @access private - */ - var $_existingConnection = false; - - /** - * String holding the database table to use. - * @var string - * @access private - */ - var $_table = 'log_table'; - - /** - * String holding the name of the ID sequence. - * @var string - * @access private - */ - var $_sequence = 'log_id'; - - /** - * Maximum length of the $ident string. This corresponds to the size of - * the 'ident' column in the SQL table. - * @var integer - * @access private - */ - var $_identLimit = 16; - - /** - * Set of field types used in the database table. - * @var array - * @access private - */ - var $_types = array( - 'id' => 'integer', - 'logtime' => 'timestamp', - 'ident' => 'text', - 'priority' => 'text', - 'message' => 'clob' - ); - - /** - * Constructs a new sql logging object. - * - * @param string $name The target SQL table. - * @param string $ident The identification field. - * @param array $conf The connection configuration array. - * @param int $level Log messages up to and including this level. - * @access public - */ - function Log_mdb2($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_table = $name; - $this->_mask = Log::UPTO($level); - - /* If an options array was provided, use it. */ - if (isset($conf['options']) && is_array($conf['options'])) { - $this->_options = $conf['options']; - } - - /* If a specific sequence name was provided, use it. */ - if (!empty($conf['sequence'])) { - $this->_sequence = $conf['sequence']; - } - - /* If a specific sequence name was provided, use it. */ - if (isset($conf['identLimit'])) { - $this->_identLimit = $conf['identLimit']; - } - - /* Now that the ident limit is confirmed, set the ident string. */ - $this->setIdent($ident); - - /* If an existing database connection was provided, use it. */ - if (isset($conf['db'])) { - $this->_db = &$conf['db']; - $this->_existingConnection = true; - $this->_opened = true; - } elseif (isset($conf['singleton'])) { - $this->_db = &MDB2::singleton($conf['singleton'], $this->_options); - $this->_existingConnection = true; - $this->_opened = true; - } else { - $this->_dsn = $conf['dsn']; - } - } - - /** - * Opens a connection to the database, if it has not already - * been opened. This is implicitly called by log(), if necessary. - * - * @return boolean True on success, false on failure. - * @access public - */ - function open() - { - if (!$this->_opened) { - /* Use the DSN and options to create a database connection. */ - $this->_db = &MDB2::connect($this->_dsn, $this->_options); - if (PEAR::isError($this->_db)) { - return false; - } - - /* Create a prepared statement for repeated use in log(). */ - if (!$this->_prepareStatement()) { - return false; - } - - /* We now consider out connection open. */ - $this->_opened = true; - } - - return $this->_opened; - } - - /** - * Closes the connection to the database if it is still open and we were - * the ones that opened it. It is the caller's responsible to close an - * existing connection that was passed to us via $conf['db']. - * - * @return boolean True on success, false on failure. - * @access public - */ - function close() - { - /* If we have a statement object, free it. */ - if (is_object($this->_statement)) { - $this->_statement->free(); - $this->_statement = null; - } - - /* If we opened the database connection, disconnect it. */ - if ($this->_opened && !$this->_existingConnection) { - $this->_opened = false; - return $this->_db->disconnect(); - } - - return ($this->_opened === false); - } - - /** - * Sets this Log instance's identification string. Note that this - * SQL-specific implementation will limit the length of the $ident string - * to sixteen (16) characters. - * - * @param string $ident The new identification string. - * - * @access public - * @since Log 1.8.5 - */ - function setIdent($ident) - { - $this->_ident = substr($ident, 0, $this->_identLimit); - } - - /** - * Inserts $message to the currently open database. Calls open(), - * if necessary. 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; - } - - /* If the connection isn't open and can't be opened, return failure. */ - if (!$this->_opened && !$this->open()) { - return false; - } - - /* If we don't already have a statement object, create one. */ - if (!is_object($this->_statement) && !$this->_prepareStatement()) { - return false; - } - - /* Extract the string representation of the message. */ - $message = $this->_extractMessage($message); - - /* Build our set of values for this log entry. */ - $values = array( - 'id' => $this->_db->nextId($this->_sequence), - 'logtime' => MDB2_Date::mdbNow(), - 'ident' => $this->_ident, - 'priority' => $priority, - 'message' => $message - ); - - /* Execute the SQL query for this log entry insertion. */ - $this->_db->expectError(MDB2_ERROR_NOSUCHTABLE); - $result = &$this->_statement->execute($values); - $this->_db->popExpect(); - - /* Attempt to handle any errors. */ - if (PEAR::isError($result)) { - /* We can only handle MDB2_ERROR_NOSUCHTABLE errors. */ - if ($result->getCode() != MDB2_ERROR_NOSUCHTABLE) { - return false; - } - - /* Attempt to create the target table. */ - if (!$this->_createTable()) { - return false; - } - - /* Recreate our prepared statement resource. */ - $this->_statement->free(); - if (!$this->_prepareStatement()) { - return false; - } - - /* Attempt to re-execute the insertion query. */ - $result = $this->_statement->execute($values); - if (PEAR::isError($result)) { - return false; - } - } - - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - - /** - * Create the log table in the database. - * - * @return boolean True on success or false on failure. - * @access private - */ - function _createTable() - { - $this->_db->loadModule('Manager', null, true); - $result = $this->_db->manager->createTable( - $this->_table, - array( - 'id' => array('type' => $this->_types['id']), - 'logtime' => array('type' => $this->_types['logtime']), - 'ident' => array('type' => $this->_types['ident']), - 'priority' => array('type' => $this->_types['priority']), - 'message' => array('type' => $this->_types['message']) - ) - ); - if (PEAR::isError($result)) { - return false; - } - - $result = $this->_db->manager->createIndex( - $this->_table, - 'unique_id', - array('fields' => array('id' => true), 'unique' => true) - ); - if (PEAR::isError($result)) { - return false; - } - - return true; - } - - /** - * Prepare the SQL insertion statement. - * - * @return boolean True if the statement was successfully created. - * - * @access private - * @since Log 1.9.0 - */ - function _prepareStatement() - { - $this->_statement = &$this->_db->prepare( - 'INSERT INTO ' . $this->_table . - ' (id, logtime, ident, priority, message)' . - ' VALUES(:id, :logtime, :ident, :priority, :message)', - $this->_types, MDB2_PREPARE_MANIP); - - /* Return success if we didn't generate an error. */ - return (PEAR::isError($this->_statement) === false); - } -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/null.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/null.php --- php-log-1.9.11/Log-1.9.11/Log/null.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/null.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,91 +0,0 @@ - - * @since Log 1.8.2 - * @package Log - * - * @example null.php Using the null handler. - */ -class Log_null extends Log -{ - /** - * Constructs a new Log_null 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_null($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - } - - /** - * Opens the handler. - * - * @access public - * @since Log 1.9.6 - */ - function open() - { - $this->_opened = true; - return true; - } - - /** - * Closes the handler. - * - * @access public - * @since Log 1.9.6 - */ - function close() - { - $this->_opened = false; - return true; - } - - /** - * Simply consumes the log event. The message will still be 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; - } - - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/observer.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/observer.php --- php-log-1.9.11/Log-1.9.11/Log/observer.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/observer.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,129 +0,0 @@ - - * @since Horde 1.3 - * @since Log 1.0 - * @package Log - * - * @example observer_mail.php An example Log_observer implementation. - */ -class Log_observer -{ - /** - * Instance-specific unique identification number. - * - * @var integer - * @access private - */ - var $_id = 0; - - /** - * The minimum priority level of message that we want to hear about. - * PEAR_LOG_EMERG is the highest priority, so we will only hear messages - * with an integer priority value less than or equal to ours. It defaults - * to PEAR_LOG_INFO, which listens to everything except PEAR_LOG_DEBUG. - * - * @var string - * @access private - */ - var $_priority = PEAR_LOG_INFO; - - /** - * Creates a new basic Log_observer instance. - * - * @param integer $priority The highest priority at which to receive - * log event notifications. - * - * @access public - */ - function Log_observer($priority = PEAR_LOG_INFO) - { - $this->_id = md5(microtime()); - $this->_priority = $priority; - } - - /** - * Attempts to return a new concrete Log_observer instance of the requested - * type. - * - * @param string $type The type of concreate Log_observer subclass - * to return. - * @param integer $priority The highest priority at which to receive - * log event notifications. - * @param array $conf Optional associative array of additional - * configuration values. - * - * @return object The newly created concrete Log_observer - * instance, or null on an error. - */ - function &factory($type, $priority = PEAR_LOG_INFO, $conf = array()) - { - $type = strtolower($type); - $class = 'Log_observer_' . $type; - - /* - * If the desired class already exists (because the caller has supplied - * it from some custom location), simply instantiate and return a new - * instance. - */ - if (class_exists($class)) { - $object = &new $class($priority, $conf); - return $object; - } - - /* Support both the new-style and old-style file naming conventions. */ - $newstyle = true; - $classfile = dirname(__FILE__) . '/observer_' . $type . '.php'; - - if (!file_exists($classfile)) { - $classfile = 'Log/' . $type . '.php'; - $newstyle = false; - } - - /* - * Attempt to include our version of the named class, but don't treat - * a failure as fatal. The caller may have already included their own - * version of the named class. - */ - @include_once $classfile; - - /* If the class exists, return a new instance of it. */ - if (class_exists($class)) { - /* Support both new-style and old-style construction. */ - if ($newstyle) { - $object = &new $class($priority, $conf); - } else { - $object = &new $class($priority); - } - return $object; - } - - $null = null; - return $null; - } - - /** - * This is a stub method to make sure that Log_Observer classes do - * something when they are notified of a message. The default behavior - * is to just print the message, which is obviously not desireable in - * practically any situation - which is why you need to override this - * method. :) - * - * @param array $event A hash describing the log event. - */ - function notify($event) - { - print_r($event); - } -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/sqlite.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/sqlite.php --- php-log-1.9.11/Log-1.9.11/Log/sqlite.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/sqlite.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,225 +0,0 @@ - - * @author Jon Parise - * @since Log 1.8.3 - * @package Log - * - * @example sqlite.php Using the Sqlite handler. - */ -class Log_sqlite extends Log -{ - /** - * Array containing the connection defaults - * @var array - * @access private - */ - var $_options = array('mode' => 0666, - 'persistent' => false); - - /** - * Object holding the database handle. - * @var object - * @access private - */ - var $_db = null; - - /** - * Flag indicating that we're using an existing database connection. - * @var boolean - * @access private - */ - var $_existingConnection = false; - - /** - * String holding the database table to use. - * @var string - * @access private - */ - var $_table = 'log_table'; - - - /** - * Constructs a new sql logging object. - * - * @param string $name The target SQL table. - * @param string $ident The identification field. - * @param mixed $conf Can be an array of configuration options used - * to open a new database connection - * or an already opened sqlite connection. - * @param int $level Log messages up to and including this level. - * @access public - */ - function Log_sqlite($name, $ident = '', &$conf, $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_table = $name; - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - - if (is_array($conf)) { - foreach ($conf as $k => $opt) { - $this->_options[$k] = $opt; - } - } else { - // If an existing database connection was provided, use it. - $this->_db =& $conf; - $this->_existingConnection = true; - } - } - - /** - * Opens a connection to the database, if it has not already - * been opened. This is implicitly called by log(), if necessary. - * - * @return boolean True on success, false on failure. - * @access public - */ - function open() - { - if (is_resource($this->_db)) { - $this->_opened = true; - return $this->_createTable(); - } else { - /* Set the connection function based on the 'persistent' option. */ - if (empty($this->_options['persistent'])) { - $connectFunction = 'sqlite_open'; - } else { - $connectFunction = 'sqlite_popen'; - } - - /* Attempt to connect to the database. */ - if ($this->_db = $connectFunction($this->_options['filename'], - (int)$this->_options['mode'], - $error)) { - $this->_opened = true; - return $this->_createTable(); - } - } - - return $this->_opened; - } - - /** - * Closes the connection to the database if it is still open and we were - * the ones that opened it. It is the caller's responsible to close an - * existing connection that was passed to us via $conf['db']. - * - * @return boolean True on success, false on failure. - * @access public - */ - function close() - { - /* We never close existing connections. */ - if ($this->_existingConnection) { - return false; - } - - if ($this->_opened) { - $this->_opened = false; - sqlite_close($this->_db); - } - - return ($this->_opened === false); - } - - /** - * Inserts $message to the currently open database. Calls open(), - * if necessary. 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; - } - - /* If the connection isn't open and can't be opened, return failure. */ - if (!$this->_opened && !$this->open()) { - return false; - } - - // Extract the string representation of the message. - $message = $this->_extractMessage($message); - - // Build the SQL query for this log entry insertion. - $q = sprintf('INSERT INTO [%s] (logtime, ident, priority, message) ' . - "VALUES ('%s', '%s', %d, '%s')", - $this->_table, - strftime('%Y-%m-%d %H:%M:%S', time()), - sqlite_escape_string($this->_ident), - $priority, - sqlite_escape_string($message)); - if (!($res = @sqlite_unbuffered_query($this->_db, $q))) { - return false; - } - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - - /** - * Checks whether the log table exists and creates it if necessary. - * - * @return boolean True on success or false on failure. - * @access private - */ - function _createTable() - { - $q = "SELECT name FROM sqlite_master WHERE name='" . $this->_table . - "' AND type='table'"; - - $res = sqlite_query($this->_db, $q); - - if (sqlite_num_rows($res) == 0) { - $q = 'CREATE TABLE [' . $this->_table . '] (' . - 'id INTEGER PRIMARY KEY NOT NULL, ' . - 'logtime NOT NULL, ' . - 'ident CHAR(16) NOT NULL, ' . - 'priority INT NOT NULL, ' . - 'message)'; - - if (!($res = sqlite_unbuffered_query($this->_db, $q))) { - return false; - } - } - - return true; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/sql.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/sql.php --- php-log-1.9.11/Log-1.9.11/Log/sql.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/sql.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,294 +0,0 @@ - - * @since Horde 1.3 - * @since Log 1.0 - * @package Log - * - * @example sql.php Using the SQL handler. - */ -class Log_sql extends Log -{ - /** - * Variable containing the DSN information. - * @var mixed - * @access private - */ - var $_dsn = ''; - - /** - * String containing the SQL insertion statement. - * - * @var string - * @access private - */ - var $_sql = ''; - - /** - * Array containing our set of DB configuration options. - * @var array - * @access private - */ - var $_options = array('persistent' => true); - - /** - * Object holding the database handle. - * @var object - * @access private - */ - var $_db = null; - - /** - * Resource holding the prepared statement handle. - * @var resource - * @access private - */ - var $_statement = null; - - /** - * Flag indicating that we're using an existing database connection. - * @var boolean - * @access private - */ - var $_existingConnection = false; - - /** - * String holding the database table to use. - * @var string - * @access private - */ - var $_table = 'log_table'; - - /** - * String holding the name of the ID sequence. - * @var string - * @access private - */ - var $_sequence = 'log_id'; - - /** - * Maximum length of the $ident string. This corresponds to the size of - * the 'ident' column in the SQL table. - * @var integer - * @access private - */ - var $_identLimit = 16; - - - /** - * Constructs a new sql logging object. - * - * @param string $name The target SQL table. - * @param string $ident The identification field. - * @param array $conf The connection configuration array. - * @param int $level Log messages up to and including this level. - * @access public - */ - function Log_sql($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $this->_id = md5(microtime()); - $this->_table = $name; - $this->_mask = Log::UPTO($level); - - /* Now that we have a table name, assign our SQL statement. */ - if (!empty($this->_sql)) { - $this->_sql = $conf['sql']; - } else { - $this->_sql = 'INSERT INTO ' . $this->_table . - ' (id, logtime, ident, priority, message)' . - ' VALUES(?, CURRENT_TIMESTAMP, ?, ?, ?)'; - } - - /* If an options array was provided, use it. */ - if (isset($conf['options']) && is_array($conf['options'])) { - $this->_options = $conf['options']; - } - - /* If a specific sequence name was provided, use it. */ - if (!empty($conf['sequence'])) { - $this->_sequence = $conf['sequence']; - } - - /* If a specific sequence name was provided, use it. */ - if (isset($conf['identLimit'])) { - $this->_identLimit = $conf['identLimit']; - } - - /* Now that the ident limit is confirmed, set the ident string. */ - $this->setIdent($ident); - - /* If an existing database connection was provided, use it. */ - if (isset($conf['db'])) { - $this->_db = &$conf['db']; - $this->_existingConnection = true; - $this->_opened = true; - } else { - $this->_dsn = $conf['dsn']; - } - } - - /** - * Opens a connection to the database, if it has not already - * been opened. This is implicitly called by log(), if necessary. - * - * @return boolean True on success, false on failure. - * @access public - */ - function open() - { - if (!$this->_opened) { - /* Use the DSN and options to create a database connection. */ - $this->_db = &DB::connect($this->_dsn, $this->_options); - if (DB::isError($this->_db)) { - return false; - } - - /* Create a prepared statement for repeated use in log(). */ - if (!$this->_prepareStatement()) { - return false; - } - - /* We now consider out connection open. */ - $this->_opened = true; - } - - return $this->_opened; - } - - /** - * Closes the connection to the database if it is still open and we were - * the ones that opened it. It is the caller's responsible to close an - * existing connection that was passed to us via $conf['db']. - * - * @return boolean True on success, false on failure. - * @access public - */ - function close() - { - if ($this->_opened && !$this->_existingConnection) { - $this->_opened = false; - $this->_db->freePrepared($this->_statement); - return $this->_db->disconnect(); - } - - return ($this->_opened === false); - } - - /** - * Sets this Log instance's identification string. Note that this - * SQL-specific implementation will limit the length of the $ident string - * to sixteen (16) characters. - * - * @param string $ident The new identification string. - * - * @access public - * @since Log 1.8.5 - */ - function setIdent($ident) - { - $this->_ident = substr($ident, 0, $this->_identLimit); - } - - /** - * Inserts $message to the currently open database. Calls open(), - * if necessary. 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; - } - - /* If the connection isn't open and can't be opened, return failure. */ - if (!$this->_opened && !$this->open()) { - return false; - } - - /* If we don't already have our statement object yet, create it. */ - if (!is_object($this->_statement) && !$this->_prepareStatement()) { - return false; - } - - /* Extract the string representation of the message. */ - $message = $this->_extractMessage($message); - - /* Build our set of values for this log entry. */ - $id = $this->_db->nextId($this->_sequence); - $values = array($id, $this->_ident, $priority, $message); - - /* Execute the SQL query for this log entry insertion. */ - $result =& $this->_db->execute($this->_statement, $values); - if (DB::isError($result)) { - return false; - } - - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - - /** - * Prepare the SQL insertion statement. - * - * @return boolean True if the statement was successfully created. - * - * @access private - * @since Log 1.9.1 - */ - function _prepareStatement() - { - $this->_statement = $this->_db->prepare($this->_sql); - - /* Return success if we didn't generate an error. */ - return (DB::isError($this->_statement) === false); - } -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/syslog.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/syslog.php --- php-log-1.9.11/Log-1.9.11/Log/syslog.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/syslog.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,179 +0,0 @@ - - * @author Jon Parise - * @since Horde 1.3 - * @since Log 1.0 - * @package Log - * - * @example syslog.php Using the syslog handler. - */ -class Log_syslog extends Log -{ - /** - * Integer holding the log facility to use. - * @var integer - * @access private - */ - var $_name = LOG_SYSLOG; - - /** - * Should we inherit the current syslog connection for this process, or - * should we call openlog() to start a new syslog connection? - * @var boolean - * @access private - */ - var $_inherit = false; - - /** - * Constructs a new syslog object. - * - * @param string $name The syslog facility. - * @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_syslog($name, $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - /* Ensure we have a valid integer value for $name. */ - if (empty($name) || !is_int($name)) { - $name = LOG_SYSLOG; - } - - if (isset($conf['inherit'])) { - $this->_inherit = $conf['inherit']; - $this->_opened = $this->_inherit; - } - - $this->_id = md5(microtime()); - $this->_name = $name; - $this->_ident = $ident; - $this->_mask = Log::UPTO($level); - } - - /** - * Opens a connection to the system logger, if it has not already - * been opened. This is implicitly called by log(), if necessary. - * @access public - */ - function open() - { - if (!$this->_opened) { - $this->_opened = openlog($this->_ident, LOG_PID, $this->_name); - } - - return $this->_opened; - } - - /** - * Closes the connection to the system logger, if it is open. - * @access public - */ - function close() - { - if ($this->_opened && !$this->_inherit) { - closelog(); - $this->_opened = false; - } - - return true; - } - - /** - * Sends $message to the currently open syslog connection. Calls - * open() if necessary. 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 int $priority (optional) 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; - } - - /* If the connection isn't open and can't be opened, return failure. */ - if (!$this->_opened && !$this->open()) { - return false; - } - - /* Extract the string representation of the message. */ - $message = $this->_extractMessage($message); - - /* Build a syslog priority value based on our current configuration. */ - $priority = $this->_toSyslog($priority); - if ($this->_inherit) { - $priority |= $this->_name; - } - - if (!syslog($priority, $message)) { - return false; - } - - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - - /** - * Converts a PEAR_LOG_* constant into a syslog LOG_* constant. - * - * This function exists because, under Windows, not all of the LOG_* - * constants have unique values. Instead, the PEAR_LOG_* were introduced - * for global use, with the conversion to the LOG_* constants kept local to - * to the syslog driver. - * - * @param int $priority PEAR_LOG_* value to convert to LOG_* value. - * - * @return The LOG_* representation of $priority. - * - * @access private - */ - function _toSyslog($priority) - { - static $priorities = array( - PEAR_LOG_EMERG => LOG_EMERG, - PEAR_LOG_ALERT => LOG_ALERT, - PEAR_LOG_CRIT => LOG_CRIT, - PEAR_LOG_ERR => LOG_ERR, - PEAR_LOG_WARNING => LOG_WARNING, - PEAR_LOG_NOTICE => LOG_NOTICE, - PEAR_LOG_INFO => LOG_INFO, - PEAR_LOG_DEBUG => LOG_DEBUG - ); - - /* If we're passed an unknown priority, default to LOG_INFO. */ - if (!is_int($priority) || !in_array($priority, $priorities)) { - return LOG_INFO; - } - - return $priorities[$priority]; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log/win.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log/win.php --- php-log-1.9.11/Log-1.9.11/Log/win.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log/win.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,269 +0,0 @@ - - * @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 styles. - * @var array - * @access private - */ - var $_styles = array( - PEAR_LOG_EMERG => 'color: red;', - PEAR_LOG_ALERT => 'color: orange;', - PEAR_LOG_CRIT => 'color: yellow;', - PEAR_LOG_ERR => 'color: green;', - PEAR_LOG_WARNING => 'color: blue;', - PEAR_LOG_NOTICE => 'color: indigo;', - PEAR_LOG_INFO => 'color: violet;', - PEAR_LOG_DEBUG => 'color: 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['styles']) && is_array($conf['styles'])) { - $this->_styles = $conf['styles']; - } - if (isset($conf['colors']) && is_array($conf['colors'])) { - foreach ($conf['colors'] as $level => $color) { - $this->_styles[$level] .= "color: $color;"; - } - } - - 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; - $styles = $this->_styles; - - if (!empty($this->_ident)) { - $identHeader = "$win.document.writeln('Ident')"; - } else { - $identHeader = ''; - } - - echo <<< EOT - -EOT; - $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); - $message = preg_replace('/\r\n|\n|\r/', '
', $message); - - list($usec, $sec) = explode(' ', microtime()); - - /* Build the output line that contains the log entry row. */ - $line = ''; - $line .= sprintf('%s.%s', - strftime('%H:%M:%S', $sec), substr($usec, 2, 2)); - if (!empty($this->_ident)) { - $line .= '' . $this->_ident . ''; - } - $line .= '' . ucfirst($this->priorityToString($priority)) . ''; - $line .= sprintf('%s', $priority, $message); - $line .= ''; - - $this->_writeln($line); - - $this->_announce(array('priority' => $priority, 'message' => $message)); - - return true; - } - -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/Log.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/Log.php --- php-log-1.9.11/Log-1.9.11/Log.php 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/Log.php 1970-01-01 01:00:00.000000000 +0100 @@ -1,824 +0,0 @@ - - * @author Jon Parise - * @since Horde 1.3 - * @package Log - */ -class Log -{ - /** - * Indicates whether or not the log can been opened / connected. - * - * @var boolean - * @access private - */ - var $_opened = false; - - /** - * Instance-specific unique identification number. - * - * @var integer - * @access private - */ - var $_id = 0; - - /** - * The label that uniquely identifies this set of log messages. - * - * @var string - * @access private - */ - var $_ident = ''; - - /** - * The default priority to use when logging an event. - * - * @var integer - * @access private - */ - var $_priority = PEAR_LOG_INFO; - - /** - * The bitmask of allowed log levels. - * - * @var integer - * @access private - */ - var $_mask = PEAR_LOG_ALL; - - /** - * Holds all Log_observer objects that wish to be notified of new messages. - * - * @var array - * @access private - */ - var $_listeners = array(); - - /** - * Maps canonical format keys to position arguments for use in building - * "line format" strings. - * - * @var array - * @access private - */ - var $_formatMap = array('%{timestamp}' => '%1$s', - '%{ident}' => '%2$s', - '%{priority}' => '%3$s', - '%{message}' => '%4$s', - '%{file}' => '%5$s', - '%{line}' => '%6$s', - '%{function}' => '%7$s', - '%\{' => '%%{'); - - - /** - * Attempts to return a concrete Log instance of type $handler. - * - * @param string $handler The type of concrete Log subclass to return. - * Attempt to dynamically include the code for - * this subclass. Currently, valid values are - * 'console', 'syslog', 'sql', 'file', and 'mcal'. - * - * @param string $name The name of the actually log file, table, or - * other specific store to use. Defaults to an - * empty string, with which the subclass will - * attempt to do something intelligent. - * - * @param string $ident The identity reported to the log system. - * - * @param array $conf A hash containing any additional configuration - * information that a subclass might need. - * - * @param int $level Log messages up to and including this level. - * - * @return object Log The newly created concrete Log instance, or - * null on an error. - * @access public - * @since Log 1.0 - */ - function &factory($handler, $name = '', $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - $handler = strtolower($handler); - $class = 'Log_' . $handler; - $classfile = 'Log/' . $handler . '.php'; - - /* - * Attempt to include our version of the named class, but don't treat - * a failure as fatal. The caller may have already included their own - * version of the named class. - */ - if (!class_exists($class)) { - include_once $classfile; - } - - /* If the class exists, return a new instance of it. */ - if (class_exists($class)) { - $obj = &new $class($name, $ident, $conf, $level); - return $obj; - } - - $null = null; - return $null; - } - - /** - * Attempts to return a reference to a concrete Log instance of type - * $handler, only creating a new instance if no log instance with the same - * parameters currently exists. - * - * You should use this if there are multiple places you might create a - * logger, you don't want to create multiple loggers, and you don't want to - * check for the existance of one each time. The singleton pattern does all - * the checking work for you. - * - * You MUST call this method with the $var = &Log::singleton() syntax. - * Without the ampersand (&) in front of the method name, you will not get - * a reference, you will get a copy. - * - * @param string $handler The type of concrete Log subclass to return. - * Attempt to dynamically include the code for - * this subclass. Currently, valid values are - * 'console', 'syslog', 'sql', 'file', and 'mcal'. - * - * @param string $name The name of the actually log file, table, or - * other specific store to use. Defaults to an - * empty string, with which the subclass will - * attempt to do something intelligent. - * - * @param string $ident The identity reported to the log system. - * - * @param array $conf A hash containing any additional configuration - * information that a subclass might need. - * - * @param int $level Log messages up to and including this level. - * - * @return object Log The newly created concrete Log instance, or - * null on an error. - * @access public - * @since Log 1.0 - */ - function &singleton($handler, $name = '', $ident = '', $conf = array(), - $level = PEAR_LOG_DEBUG) - { - static $instances; - if (!isset($instances)) $instances = array(); - - $signature = serialize(array($handler, $name, $ident, $conf, $level)); - if (!isset($instances[$signature])) { - $instances[$signature] = &Log::factory($handler, $name, $ident, - $conf, $level); - } - - return $instances[$signature]; - } - - /** - * Abstract implementation of the open() method. - * @since Log 1.0 - */ - function open() - { - return false; - } - - /** - * Abstract implementation of the close() method. - * @since Log 1.0 - */ - function close() - { - return false; - } - - /** - * Abstract implementation of the flush() method. - * @since Log 1.8.2 - */ - function flush() - { - return false; - } - - /** - * Abstract implementation of the log() method. - * @since Log 1.0 - */ - function log($message, $priority = null) - { - return false; - } - - /** - * A convenience function for logging a emergency event. It will log a - * message at the PEAR_LOG_EMERG log level. - * - * @param mixed $message String or object containing the message - * to log. - * - * @return boolean True if the message was successfully logged. - * - * @access public - * @since Log 1.7.0 - */ - function emerg($message) - { - return $this->log($message, PEAR_LOG_EMERG); - } - - /** - * A convenience function for logging an alert event. It will log a - * message at the PEAR_LOG_ALERT log level. - * - * @param mixed $message String or object containing the message - * to log. - * - * @return boolean True if the message was successfully logged. - * - * @access public - * @since Log 1.7.0 - */ - function alert($message) - { - return $this->log($message, PEAR_LOG_ALERT); - } - - /** - * A convenience function for logging a critical event. It will log a - * message at the PEAR_LOG_CRIT log level. - * - * @param mixed $message String or object containing the message - * to log. - * - * @return boolean True if the message was successfully logged. - * - * @access public - * @since Log 1.7.0 - */ - function crit($message) - { - return $this->log($message, PEAR_LOG_CRIT); - } - - /** - * A convenience function for logging a error event. It will log a - * message at the PEAR_LOG_ERR log level. - * - * @param mixed $message String or object containing the message - * to log. - * - * @return boolean True if the message was successfully logged. - * - * @access public - * @since Log 1.7.0 - */ - function err($message) - { - return $this->log($message, PEAR_LOG_ERR); - } - - /** - * A convenience function for logging a warning event. It will log a - * message at the PEAR_LOG_WARNING log level. - * - * @param mixed $message String or object containing the message - * to log. - * - * @return boolean True if the message was successfully logged. - * - * @access public - * @since Log 1.7.0 - */ - function warning($message) - { - return $this->log($message, PEAR_LOG_WARNING); - } - - /** - * A convenience function for logging a notice event. It will log a - * message at the PEAR_LOG_NOTICE log level. - * - * @param mixed $message String or object containing the message - * to log. - * - * @return boolean True if the message was successfully logged. - * - * @access public - * @since Log 1.7.0 - */ - function notice($message) - { - return $this->log($message, PEAR_LOG_NOTICE); - } - - /** - * A convenience function for logging a information event. It will log a - * message at the PEAR_LOG_INFO log level. - * - * @param mixed $message String or object containing the message - * to log. - * - * @return boolean True if the message was successfully logged. - * - * @access public - * @since Log 1.7.0 - */ - function info($message) - { - return $this->log($message, PEAR_LOG_INFO); - } - - /** - * A convenience function for logging a debug event. It will log a - * message at the PEAR_LOG_DEBUG log level. - * - * @param mixed $message String or object containing the message - * to log. - * - * @return boolean True if the message was successfully logged. - * - * @access public - * @since Log 1.7.0 - */ - function debug($message) - { - return $this->log($message, PEAR_LOG_DEBUG); - } - - /** - * Returns the string representation of the message data. - * - * If $message is an object, _extractMessage() will attempt to extract - * the message text using a known method (such as a PEAR_Error object's - * getMessage() method). If a known method, cannot be found, the - * serialized representation of the object will be returned. - * - * If the message data is already a string, it will be returned unchanged. - * - * @param mixed $message The original message data. This may be a - * string or any object. - * - * @return string The string representation of the message. - * - * @access private - */ - function _extractMessage($message) - { - /* - * If we've been given an object, attempt to extract the message using - * a known method. If we can't find such a method, default to the - * "human-readable" version of the object. - * - * We also use the human-readable format for arrays. - */ - if (is_object($message)) { - if (method_exists($message, 'getmessage')) { - $message = $message->getMessage(); - } else if (method_exists($message, 'tostring')) { - $message = $message->toString(); - } else if (method_exists($message, '__tostring')) { - if (version_compare(PHP_VERSION, '5.0.0', 'ge')) { - $message = (string)$message; - } else { - $message = $message->__toString(); - } - } else { - $message = print_r($message, true); - } - } else if (is_array($message)) { - if (isset($message['message'])) { - $message = $message['message']; - } else { - $message = print_r($message, true); - } - } - - /* Otherwise, we assume the message is a string. */ - return $message; - } - - /** - * Using debug_backtrace(), returns the file, line, and enclosing function - * name of the source code context from which log() was invoked. - * - * @param int $depth The initial number of frames we should step - * back into the trace. - * - * @return array Array containing three strings: the filename, the line, - * and the function name from which log() was called. - * - * @access private - * @since Log 1.9.4 - */ - function _getBacktraceVars($depth) - { - /* Start by generating a backtrace from the current call (here). */ - $backtrace = debug_backtrace(); - - /* - * If we were ultimately invoked by the composite handler, we need to - * increase our depth one additional level to compensate. - */ - if (strcasecmp(@$backtrace[$depth+1]['class'], 'Log_composite') == 0) { - $depth++; - } - - /* - * We're interested in the frame which invoked the log() function, so - * we need to walk back some number of frames into the backtrace. The - * $depth parameter tells us where to start looking. We go one step - * further back to find the name of the encapsulating function from - * which log() was called. - */ - $file = @$backtrace[$depth]['file']; - $line = @$backtrace[$depth]['line']; - $func = @$backtrace[$depth + 1]['function']; - - /* - * However, if log() was called from one of our "shortcut" functions, - * we're going to need to go back an additional step. - */ - if (in_array($func, array('emerg', 'alert', 'crit', 'err', 'warning', - 'notice', 'info', 'debug'))) { - $file = @$backtrace[$depth + 1]['file']; - $line = @$backtrace[$depth + 1]['line']; - $func = @$backtrace[$depth + 2]['function']; - } - - /* - * If we couldn't extract a function name (perhaps because we were - * executed from the "main" context), provide a default value. - */ - if (is_null($func)) { - $func = '(none)'; - } - - /* Return a 3-tuple containing (file, line, function). */ - return array($file, $line, $func); - } - - /** - * Produces a formatted log line based on a format string and a set of - * variables representing the current log record and state. - * - * @return string Formatted log string. - * - * @access private - * @since Log 1.9.4 - */ - function _format($format, $timestamp, $priority, $message) - { - /* - * If the format string references any of the backtrace-driven - * variables (%5, %6, %7), generate the backtrace and fetch them. - */ - if (strpos($format, '%5') || strpos($format, '%6') || strpos($format, '%7')) { - list($file, $line, $func) = $this->_getBacktraceVars(2); - } - - /* - * Build the formatted string. We use the sprintf() function's - * "argument swapping" capability to dynamically select and position - * the variables which will ultimately appear in the log string. - */ - return sprintf($format, - $timestamp, - $this->_ident, - $this->priorityToString($priority), - $message, - isset($file) ? $file : '', - isset($line) ? $line : '', - isset($func) ? $func : ''); - } - - /** - * Returns the string representation of a PEAR_LOG_* integer constant. - * - * @param int $priority A PEAR_LOG_* integer constant. - * - * @return string The string representation of $level. - * - * @since Log 1.0 - */ - function priorityToString($priority) - { - $levels = array( - PEAR_LOG_EMERG => 'emergency', - PEAR_LOG_ALERT => 'alert', - PEAR_LOG_CRIT => 'critical', - PEAR_LOG_ERR => 'error', - PEAR_LOG_WARNING => 'warning', - PEAR_LOG_NOTICE => 'notice', - PEAR_LOG_INFO => 'info', - PEAR_LOG_DEBUG => 'debug' - ); - - return $levels[$priority]; - } - - /** - * Returns the the PEAR_LOG_* integer constant for the given string - * representation of a priority name. This function performs a - * case-insensitive search. - * - * @param string $name String containing a priority name. - * - * @return string The PEAR_LOG_* integer contstant corresponding - * the the specified priority name. - * - * @since Log 1.9.0 - */ - function stringToPriority($name) - { - $levels = array( - 'emergency' => PEAR_LOG_EMERG, - 'alert' => PEAR_LOG_ALERT, - 'critical' => PEAR_LOG_CRIT, - 'error' => PEAR_LOG_ERR, - 'warning' => PEAR_LOG_WARNING, - 'notice' => PEAR_LOG_NOTICE, - 'info' => PEAR_LOG_INFO, - 'debug' => PEAR_LOG_DEBUG - ); - - return $levels[strtolower($name)]; - } - - /** - * Calculate the log mask for the given priority. - * - * This method may be called statically. - * - * @param integer $priority The priority whose mask will be calculated. - * - * @return integer The calculated log mask. - * - * @access public - * @since Log 1.7.0 - */ - function MASK($priority) - { - return (1 << $priority); - } - - /** - * Calculate the log mask for all priorities up to the given priority. - * - * This method may be called statically. - * - * @param integer $priority The maximum priority covered by this mask. - * - * @return integer The resulting log mask. - * - * @access public - * @since Log 1.7.0 - * - * @deprecated deprecated since Log 1.9.4; use Log::MAX() instead - */ - function UPTO($priority) - { - return Log::MAX($priority); - } - - /** - * Calculate the log mask for all priorities greater than or equal to the - * given priority. In other words, $priority will be the lowest priority - * matched by the resulting mask. - * - * This method may be called statically. - * - * @param integer $priority The minimum priority covered by this mask. - * - * @return integer The resulting log mask. - * - * @access public - * @since Log 1.9.4 - */ - function MIN($priority) - { - return PEAR_LOG_ALL ^ ((1 << $priority) - 1); - } - - /** - * Calculate the log mask for all priorities less than or equal to the - * given priority. In other words, $priority will be the highests priority - * matched by the resulting mask. - * - * This method may be called statically. - * - * @param integer $priority The maximum priority covered by this mask. - * - * @return integer The resulting log mask. - * - * @access public - * @since Log 1.9.4 - */ - function MAX($priority) - { - return ((1 << ($priority + 1)) - 1); - } - - /** - * Set and return the level mask for the current Log instance. - * - * @param integer $mask A bitwise mask of log levels. - * - * @return integer The current level mask. - * - * @access public - * @since Log 1.7.0 - */ - function setMask($mask) - { - $this->_mask = $mask; - - return $this->_mask; - } - - /** - * Returns the current level mask. - * - * @return interger The current level mask. - * - * @access public - * @since Log 1.7.0 - */ - function getMask() - { - return $this->_mask; - } - - /** - * Check if the given priority is included in the current level mask. - * - * @param integer $priority The priority to check. - * - * @return boolean True if the given priority is included in the current - * log mask. - * - * @access private - * @since Log 1.7.0 - */ - function _isMasked($priority) - { - return (Log::MASK($priority) & $this->_mask); - } - - /** - * Returns the current default priority. - * - * @return integer The current default priority. - * - * @access public - * @since Log 1.8.4 - */ - function getPriority() - { - return $this->_priority; - } - - /** - * Sets the default priority to the specified value. - * - * @param integer $priority The new default priority. - * - * @access public - * @since Log 1.8.4 - */ - function setPriority($priority) - { - $this->_priority = $priority; - } - - /** - * Adds a Log_observer instance to the list of observers that are listening - * for messages emitted by this Log instance. - * - * @param object $observer The Log_observer instance to attach as a - * listener. - * - * @param boolean True if the observer is successfully attached. - * - * @access public - * @since Log 1.0 - */ - function attach(&$observer) - { - if (!is_a($observer, 'Log_observer')) { - return false; - } - - $this->_listeners[$observer->_id] = &$observer; - - return true; - } - - /** - * Removes a Log_observer instance from the list of observers. - * - * @param object $observer The Log_observer instance to detach from - * the list of listeners. - * - * @param boolean True if the observer is successfully detached. - * - * @access public - * @since Log 1.0 - */ - function detach($observer) - { - if (!is_a($observer, 'Log_observer') || - !isset($this->_listeners[$observer->_id])) { - return false; - } - - unset($this->_listeners[$observer->_id]); - - return true; - } - - /** - * Informs each registered observer instance that a new message has been - * logged. - * - * @param array $event A hash describing the log event. - * - * @access private - */ - function _announce($event) - { - foreach ($this->_listeners as $id => $listener) { - if ($event['priority'] <= $this->_listeners[$id]->_priority) { - $this->_listeners[$id]->notify($event); - } - } - } - - /** - * Indicates whether this is a composite class. - * - * @return boolean True if this is a composite class. - * - * @access public - * @since Log 1.0 - */ - function isComposite() - { - return false; - } - - /** - * Sets this Log instance's identification string. - * - * @param string $ident The new identification string. - * - * @access public - * @since Log 1.6.3 - */ - function setIdent($ident) - { - $this->_ident = $ident; - } - - /** - * Returns the current identification string. - * - * @return string The current Log instance's identification string. - * - * @access public - * @since Log 1.6.3 - */ - function getIdent() - { - return $this->_ident; - } -} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/misc/log.sql /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/misc/log.sql --- php-log-1.9.11/Log-1.9.11/misc/log.sql 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/misc/log.sql 1970-01-01 01:00:00.000000000 +0100 @@ -1,10 +0,0 @@ --- $Id: log.sql,v 1.1 2006/06/26 15:25:35 jon Exp $ - -CREATE TABLE log_table ( - id INT NOT NULL, - logtime TIMESTAMP NOT NULL, - ident CHAR(16) NOT NULL, - priority INT NOT NULL, - message VARCHAR(200), - PRIMARY KEY (id) -); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/composite.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/composite.phpt --- php-log-1.9.11/Log-1.9.11/tests/composite.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/composite.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,28 +0,0 @@ ---TEST-- -Log: Composite Handler ---FILE-- - '%2$s [%3$s] %4$s'); -$console1 = &Log::singleton('console', '', 'CONSOLE1', $conf); -$console2 = &Log::singleton('console', '', 'CONSOLE2', $conf); - -$composite = &Log::singleton('composite'); -$composite->addChild($console1); -$composite->addChild($console2); - -$composite->log('This event will be logged to both handlers.'); - -$composite->setIdent('IDENT'); -echo $composite->getIdent() . "\n"; - -$composite->log('This event will be logged to both handlers.'); - ---EXPECT-- -CONSOLE1 [info] This event will be logged to both handlers. -CONSOLE2 [info] This event will be logged to both handlers. -IDENT -IDENT [info] This event will be logged to both handlers. -IDENT [info] This event will be logged to both handlers. diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/console.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/console.phpt --- php-log-1.9.11/Log-1.9.11/tests/console.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/console.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,43 +0,0 @@ ---TEST-- -Log: Console Handler ---FILE-- - '%2$s [%3$s] %4$s'); -$logger = &Log::singleton('console', '', 'ident', $conf); -for ($i = 0; $i < 3; $i++) { - $logger->log("Log entry $i"); -} - -echo "\n[Buffering / Flush Test]\n"; -$conf = array('lineFormat' => '%2$s [%3$s] %4$s', 'buffering' => true); -$buffered_logger = &Log::singleton('console', '', 'buffered', $conf); -for ($i = 0; $i < 3; $i++) { - $buffered_logger->log("Pre-flush buffered log entry $i"); -} -echo "Pre-flush\n"; -$buffered_logger->flush(); -echo "Post-flush\n"; -for ($i = 0; $i < 3; $i++) { - $buffered_logger->log("Post-flush buffered log entry $i"); -} -echo "Shutdown\n"; -$buffered_logger->close(); - ---EXPECT-- -ident [info] Log entry 0 -ident [info] Log entry 1 -ident [info] Log entry 2 - -[Buffering / Flush Test] -Pre-flush -buffered [info] Pre-flush buffered log entry 0 -buffered [info] Pre-flush buffered log entry 1 -buffered [info] Pre-flush buffered log entry 2 -Post-flush -Shutdown -buffered [info] Post-flush buffered log entry 0 -buffered [info] Post-flush buffered log entry 1 -buffered [info] Post-flush buffered log entry 2 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/display.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/display.phpt --- php-log-1.9.11/Log-1.9.11/tests/display.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/display.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,23 +0,0 @@ ---TEST-- -Log: Display Handler ---FILE-- - '', - 'error_append' => '', - 'linebreak' => "

\n"); -$logger = &Log::singleton('display', '', '', $conf); -for ($i = 0; $i < 3; $i++) { - $logger->log("Log entry $i"); -} -$logger->log("Multi\nLine\nEntry"); - ---EXPECT-- -Info: Log entry 0

-Info: Log entry 1

-Info: Log entry 2

-Info: Multi
-Line
-Entry

diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/error_log.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/error_log.phpt --- php-log-1.9.11/Log-1.9.11/tests/error_log.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/error_log.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,18 +0,0 @@ ---TEST-- -Log: Error_Log Handler ---SKIPIF-- - ---FILE-- -log("Log entry $i"); -} - ---EXPECT-- -ident: Log entry 0 -ident: Log entry 1 -ident: Log entry 2 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/extract-zend1.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/extract-zend1.phpt --- php-log-1.9.11/Log-1.9.11/tests/extract-zend1.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/extract-zend1.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,54 +0,0 @@ ---TEST-- -Log: _extractMessage() [Zend Engine 1.0] ---SKIPIF-- -=")) die('skip'); ?> ---FILE-- - '%2$s [%3$s] %4$s'); -$logger = &Log::singleton('console', '', 'ident', $conf); - -/* Logging a regular string. */ -$logger->log('String'); - -/* Logging a bare object. */ -class BareObject {} -$logger->log(new BareObject()); - -/* Logging an object with a getMessage() method. */ -class GetMessageObject { function getMessage() { return "getMessage"; } } -$logger->log(new GetMessageObject()); - -/* Logging an object with a toString() method. */ -class ToStringObject { function toString() { return "toString"; } } -$logger->log(new ToStringObject()); - -/* Logging a PEAR_Error object. */ -require_once 'PEAR.php'; -$logger->log(new PEAR_Error('PEAR_Error object', 100)); - -/* Logging an array. */ -$logger->log(array(1, 2, 'three' => 3)); - -/* Logging an array with a 'message' key. */ -$logger->log(array('message' => 'Message Key')); - ---EXPECT-- -ident [info] String -ident [info] bareobject Object -( -) - -ident [info] getMessage -ident [info] toString -ident [info] PEAR_Error object -ident [info] Array -( - [0] => 1 - [1] => 2 - [three] => 3 -) - -ident [info] Message Key diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/extract-zend2.0.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/extract-zend2.0.phpt --- php-log-1.9.11/Log-1.9.11/tests/extract-zend2.0.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/extract-zend2.0.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,62 +0,0 @@ ---TEST-- -Log: _extractMessage() [Zend Engine 2.0] ---SKIPIF-- -=")) die('skip'); -?> ---FILE-- - '%2$s [%3$s] %4$s'); -$logger = &Log::singleton('console', '', 'ident', $conf); - -/* Logging a regular string. */ -$logger->log('String'); - -/* Logging a bare object. */ -class BareObject {} -$logger->log(new BareObject()); - -/* Logging an object with a getMessage() method. */ -class GetMessageObject { function getMessage() { return "getMessage"; } } -$logger->log(new GetMessageObject()); - -/* Logging an object with a toString() method. */ -class ToStringObject { function toString() { return "toString"; } } -$logger->log(new ToStringObject()); - -/* Logging an object with a __toString() method using casting. */ -class CastableObject { function __toString() { return "__toString"; } } -$logger->log(new CastableObject()); - -/* Logging a PEAR_Error object. */ -require_once 'PEAR.php'; -$logger->log(new PEAR_Error('PEAR_Error object', 100)); - -/* Logging an array. */ -$logger->log(array(1, 2, 'three' => 3)); - -/* Logging an array with a 'message' key. */ -$logger->log(array('message' => 'Message Key')); - ---EXPECT-- -ident [info] String -ident [info] BareObject Object -( -) - -ident [info] getMessage -ident [info] toString -ident [info] Object id #2 -ident [info] PEAR_Error object -ident [info] Array -( - [0] => 1 - [1] => 2 - [three] => 3 -) - -ident [info] Message Key diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/extract-zend2.2.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/extract-zend2.2.phpt --- php-log-1.9.11/Log-1.9.11/tests/extract-zend2.2.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/extract-zend2.2.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,59 +0,0 @@ ---TEST-- -Log: _extractMessage() [Zend Engine 2.2] ---SKIPIF-- - ---FILE-- - '%2$s [%3$s] %4$s'); -$logger = &Log::singleton('console', '', 'ident', $conf); - -/* Logging a regular string. */ -$logger->log('String'); - -/* Logging a bare object. */ -class BareObject {} -$logger->log(new BareObject()); - -/* Logging an object with a getMessage() method. */ -class GetMessageObject { function getMessage() { return "getMessage"; } } -$logger->log(new GetMessageObject()); - -/* Logging an object with a toString() method. */ -class ToStringObject { function toString() { return "toString"; } } -$logger->log(new ToStringObject()); - -/* Logging an object with a __toString() method using casting. */ -class CastableObject { function __toString() { return "__toString"; } } -$logger->log(new CastableObject()); - -/* Logging a PEAR_Error object. */ -require_once 'PEAR.php'; -$logger->log(new PEAR_Error('PEAR_Error object', 100)); - -/* Logging an array. */ -$logger->log(array(1, 2, 'three' => 3)); - -/* Logging an array with a 'message' key. */ -$logger->log(array('message' => 'Message Key')); - ---EXPECT-- -ident [info] String -ident [info] BareObject Object -( -) - -ident [info] getMessage -ident [info] toString -ident [info] __toString -ident [info] PEAR_Error object -ident [info] Array -( - [0] => 1 - [1] => 2 - [three] => 3 -) - -ident [info] Message Key diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/factory.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/factory.phpt --- php-log-1.9.11/Log-1.9.11/tests/factory.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/factory.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,22 +0,0 @@ ---TEST-- -Log: Factory ---FILE-- -_id != $console2->_id) { - echo "The objects have different IDs.\n"; -} - ---EXPECT-- -Two Log_console objects. -The objects have different IDs. diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/file.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/file.phpt --- php-log-1.9.11/Log-1.9.11/tests/file.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/file.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,29 +0,0 @@ ---TEST-- -Log: File Handler ---FILE-- - '%2$s [%3$s] %4$s'); -$logger = &Log::singleton('file', $filename, '', $conf); - -for ($i = 0; $i < 3; $i++) { - $logger->log("Log entry $i"); -} -$logger->close(); - -/* Dump the contents of the log file. */ -echo file_get_contents($filename); - -/* Clean up. */ -if (file_exists($filename)) unlink($filename); - ---EXPECT-- - [info] Log entry 0 - [info] Log entry 1 - [info] Log entry 2 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/firebug.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/firebug.phpt --- php-log-1.9.11/Log-1.9.11/tests/firebug.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/firebug.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,60 +0,0 @@ ---TEST-- -Log: Firebug Handler ---FILE-- -log('Debug', PEAR_LOG_DEBUG); -$logger->log('Info', PEAR_LOG_INFO); -$logger->log('Notice', PEAR_LOG_NOTICE); -$logger->log('Warning', PEAR_LOG_WARNING); -$logger->log('Error', PEAR_LOG_ERR); -$logger->log('Critical', PEAR_LOG_CRIT); -$logger->log('Alert', PEAR_LOG_ALERT); -$logger->log('Emergency', PEAR_LOG_EMERG); -unset($logger); - -print "\n** START BUFFERING **\n"; -$conf = array('buffering' => true); -$logger = &Log::singleton('firebug', '', 'PHP', $conf); -$logger->log('Debug', PEAR_LOG_DEBUG); -$logger->log('Info', PEAR_LOG_INFO); -$logger->log('Notice', PEAR_LOG_NOTICE); -$logger->log('Warning', PEAR_LOG_WARNING); -$logger->flush(); -print "** FLUSHED **\n"; -print "** REST OF BUFFERED **\n"; -$logger->log('Error', PEAR_LOG_ERR); -$logger->log('Critical', PEAR_LOG_CRIT); -$logger->log('Alert', PEAR_LOG_ALERT); -$logger->log('Emergency', PEAR_LOG_EMERG); ---EXPECT-- -** UNBUFFERED ** - - - - - - - - - -** START BUFFERING ** - -** FLUSHED ** -** REST OF BUFFERED ** - diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/levels.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/levels.phpt --- php-log-1.9.11/Log-1.9.11/tests/levels.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/levels.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,49 +0,0 @@ ---TEST-- -Log: Levels ---FILE-- -log("Log entry $i"); -} - ---EXPECT-- diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/priority.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/priority.phpt --- php-log-1.9.11/Log-1.9.11/tests/priority.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/priority.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,30 +0,0 @@ ---TEST-- -Log: Priorities ---FILE-- - '[%3$s] %4$s'); -$logger = &Log::singleton('console', '', 'ident', $conf); - -/* Log at the default PEAR_LOG_INFO level. */ -$logger->log('Log message'); - -/* Set the default priority to PEAR_LOG_DEBUG. */ -$logger->setPriority(PEAR_LOG_DEBUG); -$logger->log('Log message'); - -/* Verify that the getPriority() method also things we're at PEAR_LOG_DEBUG. */ -$priority = $logger->priorityToString($logger->getPriority()); -echo "$priority\n"; - -/* Verify that stringToPriority() can convert back to a constant. */ -$priority = $logger->stringToPriority($priority); -echo "$priority\n"; - ---EXPECT-- -[info] Log message -[debug] Log message -debug -7 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/singleton.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/singleton.phpt --- php-log-1.9.11/Log-1.9.11/tests/singleton.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/singleton.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,22 +0,0 @@ ---TEST-- -Log: Singleton ---FILE-- -_id == $console2->_id) { - echo "The objects have the same ID.\n"; -} - ---EXPECT-- -Two Log_console objects. -The objects have the same ID. diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/sql_ident.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/sql_ident.phpt --- php-log-1.9.11/Log-1.9.11/tests/sql_ident.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/sql_ident.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,25 +0,0 @@ ---TEST-- -Log: SQL setIdent() ---SKIPIF-- -packageExists('DB')) die("skip\n"); ---FILE-- - '')); -echo $logger->getIdent() . "\n"; - -$logger->setIdent($ident); -echo $logger->getIdent() . "\n"; - ---EXPECT-- -1234567890123456 -1234567890123456 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.11/tests/sqlite.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.11/tests/sqlite.phpt --- php-log-1.9.11/Log-1.9.11/tests/sqlite.phpt 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/Log-1.9.11/tests/sqlite.phpt 1970-01-01 01:00:00.000000000 +0100 @@ -1,29 +0,0 @@ ---TEST-- -Log: Sqlite Handler ---SKIPIF-- - ---FILE-- -log($message, PEAR_LOG_WARNING); - -$q = "SELECT message FROM log_table WHERE ident='$ident'"; -$res = sqlite_query($db, $q); -if (sqlite_fetch_string($res) == $message) { - echo 'ok'; -} - -sqlite_close($db); -if (file_exists($filename)) unlink($filename); - ---EXPECT-- -ok diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/docs/guide.txt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/docs/guide.txt --- php-log-1.9.11/Log-1.9.16/docs/guide.txt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/docs/guide.txt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,1233 @@ +================= + The Log Package +================= + +-------------------- + User Documentation +-------------------- + +:Author: Jon Parise +:Contact: jon@php.net +:Date: $Date: 2008/01/19 21:43:47 $ +:Revision: $Revision: 1.38 $ + +.. contents:: Contents +.. section-numbering:: + +Using Log Handlers +================== + +The Log package is implemented as a framework that supports the notion of +backend-specific log handlers. The base logging object (defined by the `Log +class`_) is primarily an abstract interface to the currently configured +handler. + +A wide variety of handlers are distributed with the Log package, and, should +none of them fit your application's needs, it's easy to `write your own`__. + +.. _Log class: http://cvs.php.net/viewvc.cgi/pear/Log/Log.php +__ `Custom Handlers`_ + +Creating a Log Object +--------------------- +There are three ways to create Log objects: + + - Using the ``Log::factory()`` method + - Using the ``Log::singleton()`` method + - Direct instantiation + +The Factory Method +~~~~~~~~~~~~~~~~~~ +The ``Log::factory()`` method implements the `Factory Pattern`_. It allows +for the parameterized construction of concrete Log instances at runtime. The +first parameter to the ``Log::factory()`` method indicates the name of the +concrete handler to create. The rest of the parameters will be passed on to +the handler's constructor (see `Configuring a Handler`_ below). + +The new ``Log`` instance is returned by reference. + +:: + + require_once 'Log.php'; + + $console = &Log::factory('console', '', 'TEST'); + $console->log('Logging to the console.'); + + $file = &Log::factory('file', 'out.log', 'TEST'); + $file->log('Logging to out.log.'); + +.. _Factory Pattern: http://wikipedia.org/wiki/Factory_method_pattern + +The Singleton Method +~~~~~~~~~~~~~~~~~~~~ +The ``Log::singleton()`` method implements the `Singleton Pattern`_. The +singleton pattern ensures that only a single instance of a given log type and +configuration is ever created. This has two benefits: first, it prevents +duplicate ``Log`` instances from being constructed, and, second, it gives all +of your code access to the same ``Log`` instance. The latter is especially +important when logging to files because only a single file handler will need +to be managed. + +The ``Log::singleton()`` method's parameters match the ``Log::factory()`` +method. The new ``Log`` instance is returned by reference. + +:: + + require_once 'Log.php'; + + /* Same construction parameters */ + $a = &Log::singleton('console', '', 'TEST'); + $b = &Log::singleton('console', '', 'TEST'); + + if ($a === $b) { + echo '$a and $b point to the same Log instance.' . "\n"; + } + + /* Different construction parameters */ + $c = &Log::singleton('console', '', 'TEST1'); + $d = &Log::singleton('console', '', 'TEST2'); + + if ($c !== $d) { + echo '$c and $d point to different Log instances.' . "\n"; + } + +.. _Singleton Pattern: http://wikipedia.org/wiki/Singleton_pattern + +Direct Instantiation +~~~~~~~~~~~~~~~~~~~~ +It is also possible to directly instantiate concrete ``Log`` handler +instances. However, this method is **not recommended** because it creates a +tighter coupling between your application code and the Log package than is +necessary. Use of `the factory method`_ or `the singleton method`_ is +preferred. + + +Configuring a Handler +--------------------- +A log handler's configuration is determined by the arguments used in its +construction. Here's an overview of those parameters:: + + /* Using the factory method ... */ + &Log::factory($handler, $name, $ident, $conf, $maxLevel); + + /* Using the singleton method ... */ + &Log::singleton($handler, $name, $ident, $conf, $maxLevel); + + /* Using direct instantiation ... */ + new Log_handler($name, $ident, $conf, $maxLevel); + ++---------------+-----------+-----------------------------------------------+ +| Parameter | Type | Description | ++===============+===========+===============================================+ +| ``$handler`` | String | The type of Log handler to construct. This | +| | | parameter is only available when `the factory | +| | | method`_ or `the singleton method`_ are used. | ++---------------+-----------+-----------------------------------------------+ +| ``$name`` | String | The name of the log resource to which the | +| | | events will be logged. The use of this value | +| | | is determined by the handler's implementation.| +| | | It defaults to an empty string. | ++---------------+-----------+-----------------------------------------------+ +| ``$ident`` | String | An identification string that will be included| +| | | in all log events logged by this handler. | +| | | This value defaults to an empty string and can| +| | | be changed at runtime using the ``setIdent()``| +| | | method. | ++---------------+-----------+-----------------------------------------------+ +| ``$conf`` | Array | Associative array of key-value pairs that are | +| | | used to specify any handler-specific settings.| ++---------------+-----------+-----------------------------------------------+ +| ``$level`` | Integer | Log messages up to and including this level. | +| | | This value defaults to ``PEAR_LOG_DEBUG``. | +| | | See `Log Levels`_ and `Log Level Masks`_. | ++---------------+-----------+-----------------------------------------------+ + + +Logging an Event +---------------- +Events are logged using the ``log()`` method:: + + $logger->log('Message', PEAR_LOG_NOTICE); + +The first argument contains the log event's message. Even though the event is +always logged as a string, it is possible to pass an object to the ``log()`` +method. If the object implements a ``getString()`` method, a ``toString()`` +method or Zend Engine 2's special ``__toString()`` casting method, it will be +used to determine the object's string representation. Otherwise, the +`serialized`_ form of the object will be logged. + +The second, optional argument specifies the log event's priority. See the +`Log Levels`_ table for the complete list of priorities. The default priority +is PEAR_LOG_INFO. + +The ``log()`` method will return ``true`` if the event was successfully +logged. + +"Shortcut" methods are also available for logging an event at a specific log +level. See the `Log Levels`_ table for the complete list. + +.. _serialized: http://www.php.net/serialize + + +Log Levels +---------- +This table is ordered by highest priority (``PEAR_LOG_EMERG``) to lowest +priority (``PEAR_LOG_DEBUG``). + ++-----------------------+---------------+-----------------------------------+ +| Level | Shortcut | Description | ++=======================+===============+===================================+ +| ``PEAR_LOG_EMERG`` | ``emerg()`` | System is unusable | ++-----------------------+---------------+-----------------------------------+ +| ``PEAR_LOG_ALERT`` | ``alert()`` | Immediate action required | ++-----------------------+---------------+-----------------------------------+ +| ``PEAR_LOG_CRIT`` | ``crit()`` | Critical conditions | ++-----------------------+---------------+-----------------------------------+ +| ``PEAR_LOG_ERR`` | ``err()`` | Error conditions | ++-----------------------+---------------+-----------------------------------+ +| ``PEAR_LOG_WARNING`` | ``warning()`` | Warning conditions | ++-----------------------+---------------+-----------------------------------+ +| ``PEAR_LOG_NOTICE`` | ``notice()`` | Normal but significant | ++-----------------------+---------------+-----------------------------------+ +| ``PEAR_LOG_INFO`` | ``info()`` | Informational | ++-----------------------+---------------+-----------------------------------+ +| ``PEAR_LOG_DEBUG`` | ``debug()`` | Debug-level messages | ++-----------------------+---------------+-----------------------------------+ + + +Log Level Masks +--------------- +Defining a log level mask allows you to include and/or exclude specific levels +of events from being logged. The ``$level`` construction parameter (see +`Configuring a Handler`_) uses this mechanism to exclude log events below a +certain priority, and it's possible to define more complex masks once the Log +object has been constructed. + +Each priority has a specific mask associated with it. To compute a priority's +mask, use the static ``Log::MASK()`` method:: + + $mask = Log::MASK(PEAR_LOG_INFO); + +To compute the mask for all priorities up to, and including, a certain level, +use the ``Log::MAX()`` static method:: + + $mask = Log::MAX(PEAR_LOG_INFO); + +To compute the mask for all priorities greater than or equal to a certain +level, use the ``Log::MIN()`` static method:: + + $mask = Log::MIN(PEAR_LOG_INFO); + +The apply the mask, use the ``setMask()`` method:: + + $logger->setMask($mask); + +Masks can be be combined using bitwise operations. To restrict logging to +only those events marked as ``PEAR_LOG_NOTICE`` or ``PEAR_LOG_DEBUG``:: + + $mask = Log::MASK(PEAR_LOG_NOTICE) | Log::MASK(PEAR_LOG_DEBUG); + $logger->setMask($mask); + +For convenience, two special masks are predefined: ``PEAR_LOG_NONE`` and +``PEAR_LOG_ALL``. ``PEAR_LOG_ALL`` is especially useful for excluding only +specific priorities:: + + $mask = PEAR_LOG_ALL ^ Log::MASK(PEAR_LOG_NOTICE); + $logger->setMask($mask); + +It is also possible to retrieve and modify a Log object's existing mask:: + + $mask = $logger->getMask() | Log::MASK(PEAR_LOG_INFO); + $logger->setMask($mask); + + +Flushing Log Events +------------------- +Some log handlers (such as `the console handler`_) support explicit +"buffering". When buffering is enabled, log events won't actually be written +to the output stream until the handler is closed. Other handlers (such as +`the file handler`_) support implicit buffering because they use the operating +system's IO routines, which may buffer the output. + +It's possible to force these handlers to flush their output, however, by +calling their ``flush()`` method:: + + $conf = array('buffering' => true); + $logger = &Log::singleton('console', '', 'test', $conf); + + for ($i = 0; $i < 10; $i++) { + $logger->log('This event will be buffered.'); + } + + /* Flush all of the buffered log events. */ + $logger->flush(); + + for ($i = 0; $i < 10; $i++) { + $logger->log('This event will be buffered.'); + } + + /* Implicitly flush the buffered events on close. */ + $logger->close(); + +At this time, the ``flush()`` method is only implemented by `the console +handler`_, `the file handler`_, `the Firebug handler`_, and `the mail +handler`_. + + +Standard Log Handlers +===================== + +The Console Handler +------------------- +The Console handler outputs log events directly to the console. It supports +output buffering and configurable string formats. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``stream`` | File | STDOUT_ | The output stream to use. | ++-------------------+-----------+---------------+---------------------------+ +| ``buffering`` | Boolean | False | Should the output be | +| | | | buffered until shutdown? | ++-------------------+-----------+---------------+---------------------------+ +| ``lineFormat`` | String | ``%1$s %2$s | Log line format | +| | | [%3$s] %4$s`` | specification. | ++-------------------+-----------+---------------+---------------------------+ +| ``timeFormat`` | String | ``%b %d | Time stamp format | +| | | %H:%M:%S`` | (for strftime_). | ++-------------------+-----------+---------------+---------------------------+ + +.. _STDOUT: http://www.php.net/wrappers.php +.. _strftime: http://www.php.net/strftime + +Example +~~~~~~~ +:: + + $logger = &Log::singleton('console', '', 'ident'); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The Display Handler +------------------- +The Display handler simply prints the log events back to the browser. It +respects the ``error_prepend_string`` and ``error_append_string`` `error +handling values`_ and is useful when `logging from standard error handlers`_. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``lineFormat`` | String | ``%3$s:| Log line format | +| | | %4$s`` | specification. | ++-------------------+-----------+---------------+---------------------------+ +| ``timeFormat`` | String | ``%b %d | Time stamp format | +| | | %H:%M:%S`` | (for strftime_). | ++-------------------+-----------+---------------+---------------------------+ +| ``error_prepend`` | String | PHP INI value | This string will be | +| | | | prepended to the line | +| | | | format. | ++-------------------+-----------+---------------+---------------------------+ +| ``error_append`` | String | PHP INI value | This string will be | +| | | | appended to the line | +| | | | format. | ++-------------------+-----------+---------------+---------------------------+ +| ``linebreak`` | String | ``
\n`` | This string is used to | +| | | | represent a line break. | ++-------------------+-----------+---------------+---------------------------+ + +.. _error handling values: http://www.php.net/errorfunc + +Example +~~~~~~~ +:: + + $conf = array('error_prepend' => '', + 'error_append' => ''); + $logger = &Log::singleton('display', '', '', $conf, PEAR_LOG_DEBUG); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The Error_Log Handler +--------------------- +The Error_Log handler sends log events to PHP's `error_log()`_ function. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``destination`` | String | '' `(empty)` | Optional destination value| +| | | | for `error_log()`_. See | +| | | | `Error_Log Types`_ for | +| | | | more details. | ++-------------------+-----------+---------------+---------------------------+ +| ``extra_headers`` | String | '' `(empty)` | Additional headers to pass| +| | | | to the `mail()`_ function | +| | | | when the | +| | | | ``PEAR_LOG_TYPE_MAIL`` | +| | | | type is specified. | ++-------------------+-----------+---------------+---------------------------+ + +Error_Log Types +~~~~~~~~~~~~~~~ +All of the available log types are detailed in the `error_log()`_ section of +the PHP manual. For your convenience, the Log package also defines the +following constants that can be used for the ``$name`` handler construction +parameter. + ++---------------------------+-----------------------------------------------+ +| Constant | Description | ++===========================+===============================================+ +| ``PEAR_LOG_TYPE_SYSTEM`` | Log events are sent to PHP's system logger, | +| | which uses the operating system's logging | +| | mechanism or a file (depending on the value | +| | of the `error_log configuration directive`_). | ++---------------------------+-----------------------------------------------+ +| ``PEAR_LOG_TYPE_MAIL`` | Log events are sent via email to the address | +| | specified in the ``destination`` value. | ++---------------------------+-----------------------------------------------+ +| ``PEAR_LOG_TYPE_DEBUG`` | Log events are sent through PHP's debugging | +| | connection. This will only work if | +| | `remote debugging`_ has been enabled. The | +| | ``destination`` value is used to specify the | +| | host name or IP address of the target socket. | ++---------------------------+-----------------------------------------------+ +| ``PEAR_LOG_TYPE_FILE`` | Log events will be appended to the file named | +| | by the ``destination`` value. | ++---------------------------+-----------------------------------------------+ + +.. _error_log(): http://www.php.net/error_log +.. _mail(): http://www.php.net/mail +.. _error_log configuration directive: http://www.php.net/errorfunc#ini.error-log +.. _remote debugging: http://www.php.net/install.configure#install.configure.enable-debugger + +Example +~~~~~~~ +:: + + $logger = &Log::singleton('error_log', PEAR_LOG_TYPE_SYSTEM, 'ident'); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The File Handler +---------------- +The File handler writes log events to a text file using configurable string +formats. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``append`` | Boolean | True | Should new log entries be | +| | | | append to an existing log | +| | | | file, or should the a new | +| | | | log file overwrite an | +| | | | existing one? | ++-------------------+-----------+---------------+---------------------------+ +| ``locking`` | Boolean | False | Should advisory file | +| | | | locking (using flock_) be | +| | | | used? | ++-------------------+-----------+---------------+---------------------------+ +| ``mode`` | Integer | 0644 | Octal representation of | +| | | | the log file's permissions| +| | | | mode. | ++-------------------+-----------+---------------+---------------------------+ +| ``dirmode`` | Integer | 0755 | Octal representation of | +| | | | the file permission mode | +| | | | that will be used when | +| | | | creating directories that | +| | | | do not already exist. | ++-------------------+-----------+---------------+---------------------------+ +| ``eol`` | String | OS default | The end-on-line character | +| | | | sequence. | ++-------------------+-----------+---------------+---------------------------+ +| ``lineFormat`` | String | ``%1$s %2$s | Log line format | +| | | [%3$s] %4$s`` | specification. | ++-------------------+-----------+---------------+---------------------------+ +| ``timeFormat`` | String | ``%b %d | Time stamp format | +| | | %H:%M:%S`` | (for strftime_). | ++-------------------+-----------+---------------+---------------------------+ + +.. _flock: http://www.php.net/flock +.. _strftime: http://www.php.net/strftime + +The file handler will only attempt to set the ``mode`` value if it was +responsible for creating the file. + +Example +~~~~~~~ +:: + + $conf = array('mode' => 0600, 'timeFormat' => '%X %x'); + $logger = &Log::singleton('file', 'out.log', 'ident', $conf); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The Firebug Handler +------------------- +The Firebug handler outputs log events to the Firebug_ console. It supports +output buffering and configurable string formats. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``buffering`` | Boolean | False | Should the output be | +| | | | buffered until shutdown? | ++-------------------+-----------+---------------+---------------------------+ +| ``lineFormat`` | String | ``%2$s [%3$s] | Log line format | +| | | %4$s`` | specification. | ++-------------------+-----------+---------------+---------------------------+ +| ``timeFormat`` | String | ``%b %d | Time stamp format | +| | | %H:%M:%S`` | (for strftime_). | ++-------------------+-----------+---------------+---------------------------+ + +.. _Firebug: http://www.getfirebug.com/ +.. _strftime: http://www.php.net/strftime + +Example +~~~~~~~ +:: + + $logger = &Log::singleton('firebug', '', 'ident'); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The Mail Handler +---------------- +The Mail handler aggregates a session's log events and sends them in the body +of an email message using PHP's `mail()`_ function. + +Multiple recipients can be specified by separating their email addresses with +commas in the ``$name`` construction parameter. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``from`` | String | sendmail_from | Value for the message's | +| | | INI value | ``From:`` header. | ++-------------------+-----------+---------------+---------------------------+ +| ``subject`` | String | ``[Log_mail] | Value for the message's | +| | | Log message`` | ``Subject:`` header. | ++-------------------+-----------+---------------+---------------------------+ +| ``preamble`` | String | `` `(empty)` | Preamble for the message. | ++-------------------+-----------+---------------+---------------------------+ +| ``lineFormat`` | String | ``%1$s %2$s | Log line format | +| | | [%3$s] %4$s`` | specification. | ++-------------------+-----------+---------------+---------------------------+ +| ``timeFormat`` | String | ``%b %d | Time stamp format | +| | | %H:%M:%S`` | (for strftime_). | ++-------------------+-----------+---------------+---------------------------+ + +.. _mail(): http://www.php.net/mail + +Example +~~~~~~~ +:: + + $conf = array('subject' => 'Important Log Events'); + $logger = &Log::singleton('mail', 'webmaster@example.com', 'ident', $conf); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The MDB2 Handler +---------------- +The MDB2 handler is similar to `the SQL (DB) handler`_, but instead of using +the PEAR DB package, it uses the `MDB2 database abstraction package`_. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``dsn`` | Mixed | '' `(empty)` | A `Data Source Name`_. | +| | | | |required| | ++-------------------+-----------+---------------+---------------------------+ +| ``options`` | Array | ``persistent``| An array of `MDB2`_ | +| | | | options. | ++-------------------+-----------+---------------+---------------------------+ +| ``db`` | Object | NULL | An existing `MDB2`_ | +| | | | object. If specified, | +| | | | this object will be used, | +| | | | and ``dsn`` will be | +| | | | ignored. | ++-------------------+-----------+---------------+---------------------------+ +| ``sequence`` | String | ``log_id`` | The name of the sequence | +| | | | to use when generating | +| | | | unique event IDs. Under | +| | | | many databases, this will | +| | | | be used as the name of | +| | | | the sequence table. | ++-------------------+-----------+---------------+---------------------------+ +| ``identLimit`` | Integer | 16 | The maximum length of the | +| | | | ``ident`` string. | +| | | | **Changing this value may | +| | | | require updates to the SQL| +| | | | schema, as well.** | ++-------------------+-----------+---------------+---------------------------+ +| ``singleton`` | Boolean | false | Is true, use a singleton | +| | | | database object using | +| | | | `MDB2::singleton()`_. | ++-------------------+-----------+---------------+---------------------------+ + +.. _MDB2: http://pear.php.net/package/MDB2 +.. _MDB2 database abstraction package: MDB2_ +.. _MDB2::singleton(): http://pear.php.net/package/MDB2/docs/latest/MDB2/MDB2.html#methodsingleton + +The Null Handler +---------------- +The Null handler simply consumes log events (akin to sending them to +``/dev/null``). `Log level masks`_ are respected, and the event will still be +sent to any registered `log observers`_. + +Example +~~~~~~~ +:: + + $logger = &Log::singleton('null'); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The SQL (DB) Handler +-------------------- + +The SQL handler sends log events to a database using `PEAR's DB abstraction +layer`_. + +**Note:** Due to the constraints of the default database schema, the SQL +handler limits the length of the ``$ident`` string to sixteen (16) characters. +This limit can be adjusted using the ``identLimit`` configuration parameter. + +The Log Table +~~~~~~~~~~~~~ +The default SQL table used by this handler looks like this:: + + CREATE TABLE log_table ( + id INT NOT NULL, + logtime TIMESTAMP NOT NULL, + ident CHAR(16) NOT NULL, + priority INT NOT NULL, + message VARCHAR(200), + PRIMARY KEY (id) + ); + +This is the "lowest common denominator" that should work across all SQL +compliant database. You may want to make database- or site-specific changes +to this schema to support your specific needs, however. For example, +`PostgreSQL`_ users may prefer to use a ``TEXT`` type for the ``message`` +field. + +.. _PostgreSQL: http://www.postgresql.org/ + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``dsn`` | Mixed | '' `(empty)` | A `Data Source Name`_. | +| | | | |required| | ++-------------------+-----------+---------------+---------------------------+ +| ``sql`` | String | |sql-default| | SQL insertion statement. | ++-------------------+-----------+---------------+---------------------------+ +| ``options`` | Array | ``persistent``| An array of `DB`_ options.| ++-------------------+-----------+---------------+---------------------------+ +| ``db`` | Object | NULL | An existing `DB`_ object. | +| | | | If specified, this object | +| | | | will be used, and ``dsn`` | +| | | | will be ignored. | ++-------------------+-----------+---------------+---------------------------+ +| ``sequence`` | String | ``log_id`` | The name of the sequence | +| | | | to use when generating | +| | | | unique event IDs. Under | +| | | | many databases, this will | +| | | | be used as the name of | +| | | | the sequence table. | ++-------------------+-----------+---------------+---------------------------+ +| ``identLimit`` | Integer | 16 | The maximum length of the | +| | | | ``ident`` string. | +| | | | **Changing this value may | +| | | | require updates to the SQL| +| | | | schema, as well.** | ++-------------------+-----------+---------------+---------------------------+ + +The name of the database table to which the log entries will be written is +specified using the ``$name`` construction parameter (see `Configuring a +Handler`_). + +.. |sql-default| replace:: ``INSERT INTO $table (id, logtime, ident, priority, message) VALUES(?, CURRENT_TIMESTAMP, ?, ?, ?)`` + +.. _DB: http://pear.php.net/package/DB +.. _PEAR's DB abstraction layer: DB_ +.. _Data Source Name: http://pear.php.net/manual/en/package.database.db.intro-dsn.php + +Examples +~~~~~~~~ +Using a `Data Source Name`_ to create a new database connection:: + + $conf = array('dsn' => 'pgsql://jon@localhost+unix/logs'); + $logger = &Log::singleton('sql', 'log_table', 'ident', $conf); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + +Using an existing `DB`_ object:: + + require_once 'DB.php'; + $db = &DB::connect('pgsql://jon@localhost+unix/logs'); + + $conf['db'] = $db; + $logger = &Log::singleton('sql', 'log_table', 'ident', $conf); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The Sqlite Handler +------------------ +:Author: Bertrand Mansion + +The Sqlite handler sends log events to an Sqlite database using the `native +PHP sqlite functions`_. + +It is faster than `the SQL (DB) handler`_ because requests are made directly +to the database without using an abstraction layer. It is also interesting to +note that Sqlite database files can be moved, copied, and deleted on your +system just like any other files, which makes log management easier. Last but +not least, using a database to log your events allows you to use SQL queries +to create reports and statistics. + +When using a database and logging a lot of events, it is recommended to split +the database into smaller databases. This is allowed by Sqlite, and you can +later use the Sqlite `ATTACH`_ statement to query your log database files +globally. + +If the database does not exist when the log is opened, sqlite will try to +create it automatically. If the log table does not exist, it will also be +automatically created. The table creation uses the following SQL request:: + + CREATE TABLE log_table ( + id INTEGER PRIMARY KEY NOT NULL, + logtime NOT NULL, + ident CHAR(16) NOT NULL, + priority INT NOT NULL, + message + ); + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``filename`` | String | '' `(empty)` | Path to an Sqlite | +| | | | database. |required| | ++-------------------+-----------+---------------+---------------------------+ +| ``mode`` | Integer | 0666 | Octal mode used to open | +| | | | the database. | ++-------------------+-----------+---------------+---------------------------+ +| ``persistent`` | Boolean | false | Use a persistent | +| | | | connection. | ++-------------------+-----------+---------------+---------------------------+ + +An already opened database connection can also be passed as parameter instead +of the above configuration. In this case, closing the database connection is +up to the user. + +.. _native PHP sqlite functions: http://www.php.net/sqlite +.. _ATTACH: http://www.sqlite.org/lang.html#attach + +Examples +~~~~~~~~ +Using a configuration to create a new database connection:: + + $conf = array('filename' => 'log.db', 'mode' => 0666, 'persistent' => true); + $logger =& Log::factory('sqlite', 'log_table', 'ident', $conf); + $logger->log('logging an event', PEAR_LOG_WARNING); + +Using an existing connection:: + + $db = sqlite_open('log.db', 0666, $error); + $logger =& Log::factory('sqlite', 'log_table', 'ident', $db); + $logger->log('logging an event', PEAR_LOG_WARNING); + sqlite_close($db); + + +The Syslog Handler +------------------ +The Syslog handler sends log events to the system logging service (syslog on +Unix-like environments or the Event Log on Windows systems). The events are +sent using PHP's `syslog()`_ function. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``inherit`` | Boolean | false | Inherit the current syslog| +| | | | connection for this | +| | | | process, or start a new | +| | | | one via `openlog()`_? | ++-------------------+-----------+---------------+---------------------------+ + +Facilities +~~~~~~~~~~ ++-------------------+-------------------------------------------------------+ +| Constant | Category Description | ++===================+=======================================================+ +| ``LOG_AUTH`` | Security / authorization messages; ``LOG_AUTHPRIV`` is| +| | preferred on systems where it is defined. | ++-------------------+-------------------------------------------------------+ +| ``LOG_AUTHPRIV`` | Private security / authorization messages | ++-------------------+-------------------------------------------------------+ +| ``LOG_CRON`` | Clock daemon (``cron`` and ``at``) | ++-------------------+-------------------------------------------------------+ +| ``LOG_DAEMON`` | System daemon processes | ++-------------------+-------------------------------------------------------+ +| ``LOG_KERN`` | Kernel messages | ++-------------------+-------------------------------------------------------+ +| ``LOG_LOCAL0`` .. | Reserved for local use; **not** available under | +| ``LOG_LOCAL7`` | Windows. | ++-------------------+-------------------------------------------------------+ +| ``LOG_LPR`` | Printer subsystem | ++-------------------+-------------------------------------------------------+ +| ``LOG_MAIL`` | Mail subsystem | ++-------------------+-------------------------------------------------------+ +| ``LOG_NEWS`` | USENET news subsystem | ++-------------------+-------------------------------------------------------+ +| ``LOG_SYSLOG`` | Internal syslog messages | ++-------------------+-------------------------------------------------------+ +| ``LOG_USER`` | Generic user-level messages | ++-------------------+-------------------------------------------------------+ +| ``LOG_UUCP`` | UUCP subsystem | ++-------------------+-------------------------------------------------------+ + +.. _syslog(): http://www.php.net/syslog +.. _openlog(): http://www.php.net/openlog + +Example +~~~~~~~ +:: + + $logger = &Log::singleton('syslog', LOG_LOCAL0, 'ident'); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +The Window Handler +------------------ +The Window handler sends log events to a separate browser window. The +original idea for this handler was inspired by Craig Davis' Zend.com article +entitled `"JavaScript Power PHP Debugging"`_. + +Configuration +~~~~~~~~~~~~~ ++-------------------+-----------+---------------+---------------------------+ +| Parameter | Type | Default | Description | ++===================+===========+===============+===========================+ +| ``title`` | String | ``Log Output | The title of the output | +| | | Window`` | window. | ++-------------------+-----------+---------------+---------------------------+ +| ``styles`` | Array | `ROY G BIV`_ | Mapping of log priorities | +| | | (high to low) | to CSS styles. | ++-------------------+-----------+---------------+---------------------------+ + +**Note:** The Window handler may not work reliably when PHP's `output +buffering`_ system is enabled. + +.. _"JavaScript Power PHP Debugging": http://www.zend.com/zend/tut/tutorial-DebugLib.php +.. _ROY G BIV: http://www.cis.rit.edu/ +.. _output buffering: http://www.php.net/outcontrol + +Example +~~~~~~~ +:: + + $conf = array('title' => 'Sample Log Output'); + $logger = &Log::singleton('win', 'LogWindow', 'ident', $conf); + for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); + } + + +Composite Handlers +================== +It is often useful to log events to multiple handlers. The Log package +provides a compositing system that marks this task trivial. + +Start by creating the individual log handlers:: + + $console = &Log::singleton('console', '', 'TEST'); + $file = &Log::singleton('file', 'out.log', 'TEST'); + +Then, construct a composite handler and add the individual handlers as +children of the composite:: + + $composite = &Log::singleton('composite'); + $composite->addChild($console); + $composite->addChild($file); + +The composite handler implements the standard ``Log`` interface so you can use +it just like any of the other handlers:: + + $composite->log('This event will be logged to both handlers.'); + +Children can be removed from the composite when they're not longer needed:: + + $composite->removeChild($file); + + +Log Observers +============= +Log observers provide an implementation of the `observer pattern`_. In the +content of the Log package, they provide a mechanism by which you can examine +(i.e. observe) each event as it is logged. This allows the implementation of +special behavior based on the contents of a log event. For example, the +observer code could send an alert email if a log event contained the string +``PANIC``. + +Creating a log observer involves implementing a subclass of the +``Log_observer`` class. The subclass must override the base class's +``notify()`` method. This method is passed a hash containing the event's +priority and event. The subclass's implementation is free to act upon this +information in any way it likes. + +Log observers are attached to ``Log`` instances via the ``attach()`` method:: + + $observer = &Log_observer::factory('yourType'); + $logger->attach($observer); + +Observers can be detached using the ``detach()`` method:: + + $logger->detach($observer); + +At this time, no concrete ``Log_observer`` implementations are distributed +with the Log package. + +.. _observer pattern: http://wikipedia.org/wiki/Observer_pattern + + +Logging From Standard Error Handlers +==================================== + +Logging PHP Errors +------------------ +PHP's default error handler can be overridden using the `set_error_handler()`_ +function. The custom error handling function can use a global Log instance to +log the PHP errors. + +**Note:** Fatal PHP errors cannot be handled by a custom error handler at this +time. + +:: + + function errorHandler($code, $message, $file, $line) + { + global $logger; + + /* Map the PHP error to a Log priority. */ + switch ($code) { + case E_WARNING: + case E_USER_WARNING: + $priority = PEAR_LOG_WARNING; + break; + case E_NOTICE: + case E_USER_NOTICE: + $priority = PEAR_LOG_NOTICE; + break; + case E_ERROR: + case E_USER_ERROR: + $priority = PEAR_LOG_ERR; + break; + default: + $priority = PEAR_LOG_INFO; + } + + $logger->log($message . ' in ' . $file . ' at line ' . $line, + $priority); + } + + set_error_handler('errorHandler'); + trigger_error('This is an information log message.', E_USER_NOTICE); + +.. _set_error_handler(): http://www.php.net/set_error_handler + +Logging PHP Assertions +---------------------- +PHP allows user-defined `assert()`_ callback handlers. The assertion callback +is configured using the `assert_options()`_ function. + +:: + + function assertCallback($file, $line, $message) + { + global $logger; + + $logger->log($message . ' in ' . $file . ' at line ' . $line, + PEAR_LOG_ALERT); + } + + assert_options(ASSERT_CALLBACK, 'assertCallback'); + assert(false); + +.. _assert(): http://www.php.net/assert +.. _assert_options(): http://www.php.net/assert_options + +Logging PHP Exceptions +---------------------- +PHP 5 and later support the concept of `exceptions`_. A custom exception +handler can be assigned using the `set_exception_handler()`_ function. + +:: + + function exceptionHandler($exception) + { + global $logger; + + $logger->log($exception->getMessage(), PEAR_LOG_ALERT); + } + + set_exception_handler('exceptionHandler'); + throw new Exception('Uncaught Exception'); + +.. _exceptions: http://www.php.net/exceptions +.. _set_exception_handler(): http://www.php.net/set_exception_handler + +Logging PEAR Errors +------------------- +The Log package can be used with `PEAR::setErrorHandling()`_'s +``PEAR_ERROR_CALLBACK`` mechanism by writing an error handling function that +uses a global Log instance. Here's an example:: + + function errorHandler($error) + { + global $logger; + + $message = $error->getMessage(); + + if (!empty($error->backtrace[1]['file'])) { + $message .= ' (' . $error->backtrace[1]['file']; + if (!empty($error->backtrace[1]['line'])) { + $message .= ' at line ' . $error->backtrace[1]['line']; + } + $message .= ')'; + } + + $logger->log($message, $error->code); + } + + PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'errorHandler'); + PEAR::raiseError('This is an information log message.', PEAR_LOG_INFO); + +.. _PEAR::setErrorHandling(): http://pear.php.net/manual/en/core.pear.pear.seterrorhandling.php + + +Custom Handlers +=============== +There are times when the standard handlers aren't a perfect match for your +needs. In those situations, the solution might be to write a custom handler. + +Using a Custom Handler +---------------------- +Using a custom Log handler is very simple. Once written (see `Writing New +Handlers`_ and `Extending Existing Handlers`_ below), you have the choice of +placing the file in your PEAR installation's main ``Log/`` directory (usually +something like ``/usr/local/lib/php/Log`` or ``C:\php\pear\Log``), where it +can be found and use by any PHP application on the system, or placing the file +somewhere in your application's local hierarchy and including it before the +the custom Log object is constructed. + +Method 1: Handler in the Standard Location +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +After copying the handler file to your PEAR installation's ``Log/`` directory, +simply treat the handler as if it were part of the standard distributed. If +your handler is named ``custom`` (and therefore implemented by a class named +``Log_custom``):: + + require_once 'Log.php'; + + $logger = &Log::factory('custom', '', 'CUSTOM'); + + +Method 2: Handler in a Custom Location +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If you prefer storing your handler in your application's local hierarchy, +you'll need to include that file before you can create a Log instance based on +it. + +:: + + require_once 'Log.php'; + require_once 'LocalHandlers/custom.php'; + + $logger = &Log::factory('custom', '', 'CUSTOM'); + + +Writing New Handlers +-------------------- +Writing a new Log handler is as simple as authoring a new class that extends +the ``Log`` class and that implements a relatively small set of standard +methods. + +Every handler's class name must start with ``Log_`` in order for it to be +recognized by the Log package. + +:: + + class Log_custom extends Log + +The handler's constructor will be called with four parameters. These values +are discussed in detail in the `Configuring a Handler`_ section. + +:: + + Log_custom($name, $ident = '', $conf = array(), $level = PEAR_LOG_DEBUG) + +The constructor is responsible for configuring the handler based on these +values. Handler-specific parameters are passed as part of the ``$conf`` +array. At a minimum, the handler's constructor must set the following values +defined by the ``Log`` base class:: + + $this->_id = md5(microtime()); + $this->_name = $name; + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + +The `Handler Methods`_ section below details the various standard methods that +can be implemented by a log handler. The `Utility Methods`_ section describes +some useful utility methods provided by the ``Log`` base class which may be +useful when implementing a log handler. + + +Extending Existing Handlers +--------------------------- +Extending existing handlers is very similar to `writing new handlers`_ with +the exception that, instead of inheriting from the ``Log`` base class +directly, the handler extends an existing handler's class. This is a useful +way of adding some custom behavior to an existing handler without writing an +entirely new class (in the spirit of object-oriented programming). + +For example, `the mail handler`_ could be extended to support sending messages +with MIME-encoded attachments simply by authoring a new ``Log_mail_mime`` +class with a compliant constructor and a custom ``log()`` method. The rest of +the standard methods would fall back on the ``Log_mail`` base class's +implementations. + +Obviously, the specific details involved in extending an existing handler +require a good working understanding of that handler's implementation. + + +Handler Methods +--------------- + +bool open() +~~~~~~~~~~~ +The ``open()`` method is called to open the log resource for output. Handlers +can call ``open()`` immediately upon construction or lazily at runtime +(perhaps when the first log event is received). + +The ``Log`` base class provides a protected ``$_opened`` member variable which +should be set to ``true`` when the log handler is opened and ``false`` when it +is closed. Handler methods can inspect this value to determine whether or not +the handler is currently open and ready for output. + +If the ``open()`` method fails to ready the handler for output, it should +return ``false`` and set ``$this->_opened`` to ``false``. + +bool close() +~~~~~~~~~~~~ +The ``close()`` method is called to close the log resource. This method is +the analog of the ``open()`` method. It should be safe to call ``close()`` +even when the handler is not open for output. + +If the ``close()`` method fails to close the handler, it should return +``false``. Otherwise, it should return ``true``. The ``$this->_opened`` +flag should also be updated appropriately. + +bool flush() +~~~~~~~~~~~~ +The ``flush()`` method flushes any buffered log events, as described in +`Flushing Log Events`_. The implementation of this method will be largely +handler-specific. If the handler does not support buffered output, +implementing this method is not necessary; the ``Log`` class's ``flush()`` +method will be called instead. + +bool log($message, $priority = null) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The ``log()`` method is the core of every log handler. It is called whenever +the user wishes to log an event. The implementation of this method is very +handler-specific. It should return ``true`` or ``false``, depending on +whether or not the message was successfully logged by the handler. + +The ``log()`` implementation should be sure to call `_announce()`__ whenever +an event is successfully logged. + +.. __: void _announce($event) + +Utility Methods +--------------- +These utility methods are provided by the ``Log`` base class and provide +common, useful functionality to handler implementations. + +string _extractMessage($message) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This method returns the string representation of the provided message data. + +If ``$message`` is an object, ``_extractMessage()`` will attempt to extract +the message text using a known method (such as a `PEAR_Error`_ object's +`getMessage()`_ method). If a known method, cannot be found, the serialized +representation of the object will be returned. + +If the message data is already a string, it will be returned unchanged. + +.. _PEAR_Error: http://pear.php.net/manual/en/core.pear.pear-error.php +.. _getMessage(): http://pear.php.net/manual/en/core.pear.pear-error.getmessage.php + +string _format($format, $timestamp, $priority, $message) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This method produces a formatted log line based on a format string and a set +of variables representing the current log record and state. + +bool _isMasked($priority) +~~~~~~~~~~~~~~~~~~~~~~~~~ +This method checks if the given priority is included in the handler's current +level mask. This is useful for determining whether or not a log event should +be written to the handler's log. + +void _announce($event) +~~~~~~~~~~~~~~~~~~~~~~ +This method informs any registered `log observers`_ that a new event has been +logged. ``$event`` is an array containing two named elements:: + + array('priority' => $priority, 'message' => $message) + +``_announce()`` should be called from a handler's `log()`_ method whenever an +event is successfully logged. Otherwise, registered observers will never +become aware of the event. + +.. _log(): bool log($message, $priority = null) + +.. |required| replace:: **[required]** + +.. vim: tabstop=4 shiftwidth=4 softtabstop=4 expandtab textwidth=78 ft=rst: diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/composite.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/composite.php --- php-log-1.9.11/Log-1.9.16/examples/composite.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/composite.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,12 @@ +addChild($console); +$composite->addChild($file); + +$composite->log('This event will be logged to both handlers.'); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/console.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/console.php --- php-log-1.9.11/Log-1.9.16/examples/console.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/console.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,8 @@ +log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/display.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/display.php --- php-log-1.9.11/Log-1.9.16/examples/display.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/display.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,10 @@ + '', + 'error_append' => ''); +$logger = &Log::singleton('display', '', '', $conf, PEAR_LOG_DEBUG); +for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/error_log.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/error_log.php --- php-log-1.9.11/Log-1.9.16/examples/error_log.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/error_log.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,8 @@ +log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/file.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/file.php --- php-log-1.9.11/Log-1.9.16/examples/file.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/file.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,9 @@ + 0600, 'timeFormat' => '%X %x'); +$logger = &Log::singleton('file', 'out.log', 'ident', $conf); +for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/firebug.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/firebug.php --- php-log-1.9.11/Log-1.9.16/examples/firebug.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/firebug.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,12 @@ + true), + PEAR_LOG_DEBUG); + +for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/mail.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/mail.php --- php-log-1.9.11/Log-1.9.16/examples/mail.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/mail.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,9 @@ + 'Important Log Events'); +$logger = &Log::singleton('mail', 'webmaster@example.com', 'ident', $conf); +for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/null.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/null.php --- php-log-1.9.11/Log-1.9.16/examples/null.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/null.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,8 @@ +log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/observer_mail.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/observer_mail.php --- php-log-1.9.11/Log-1.9.16/examples/observer_mail.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/observer_mail.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,30 @@ +Log_observer($priority); + + /* Configure the observer. */ + $this->_to = $conf['to']; + $this->_subject = $conf['subject']; + $this->_pattern = $conf['pattern']; + } + + function notify($event) + { + if (preg_match($this->_pattern, $event['message']) != 0) { + mail($this->_to, $this->_subject, $event['message']); + } + } +} + +?> diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/pear_error_handler.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/pear_error_handler.php --- php-log-1.9.11/Log-1.9.16/examples/pear_error_handler.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/pear_error_handler.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,25 @@ +getMessage(); + + if (!empty($error->backtrace[1]['file'])) { + $message .= ' (' . $error->backtrace[1]['file']; + if (!empty($error->backtrace[1]['line'])) { + $message .= ' at line ' . $error->backtrace[1]['line']; + } + $message .= ')'; + } + + $logger->log($message, $error->code); +} + +$logger = &Log::singleton('console', '', 'ident'); + +PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'errorHandler'); +PEAR::raiseError('This is an information log message.', PEAR_LOG_INFO); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/php_error_handler.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/php_error_handler.php --- php-log-1.9.11/Log-1.9.16/examples/php_error_handler.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/php_error_handler.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,34 @@ +log($message . ' in ' . $file . ' at line ' . $line, + $priority); +} + +$logger = &Log::singleton('console', '', 'ident'); + +set_error_handler('errorHandler'); +trigger_error('This is an information log message.', E_USER_NOTICE); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/sqlite.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/sqlite.php --- php-log-1.9.11/Log-1.9.16/examples/sqlite.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/sqlite.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,14 @@ + 'log.db', 'mode' => 0666, 'persistent' => true); +$logger =& Log::factory('sqlite', 'log_table', 'ident', $conf); +$logger->log('logging an event', PEAR_LOG_WARNING); + +/* Using an existing database connection. */ +$db = sqlite_open('log.db', 0666, $error); +$logger =& Log::factory('sqlite', 'log_table', 'ident', $db); +$logger->log('logging an event', PEAR_LOG_WARNING); +sqlite_close($db); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/sql.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/sql.php --- php-log-1.9.11/Log-1.9.16/examples/sql.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/sql.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,9 @@ + 'pgsql://jon@localhost+unix/logs'); +$logger = &Log::singleton('sql', 'log_table', 'ident', $conf); +for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/syslog.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/syslog.php --- php-log-1.9.11/Log-1.9.16/examples/syslog.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/syslog.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,8 @@ +log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/examples/win.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/examples/win.php --- php-log-1.9.11/Log-1.9.16/examples/win.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/examples/win.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,9 @@ + 'Sample Log Output'); +$logger = &Log::singleton('win', 'LogWindow', 'ident', $conf); +for ($i = 0; $i < 10; $i++) { + $logger->log("Log entry $i"); +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/composite.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/composite.php --- php-log-1.9.11/Log-1.9.16/Log/composite.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/composite.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,231 @@ + + * @author Jon Parise + * + * @since Horde 1.3 + * @since Log 1.0 + * @package Log + * + * @example composite.php Using the composite handler. + */ +class Log_composite extends Log +{ + /** + * Array holding all of the Log instances to which log events should be + * sent. + * + * @var array + * @access private + */ + var $_children = array(); + + + /** + * Constructs a new composite Log object. + * + * @param boolean $name This parameter is ignored. + * @param boolean $ident This parameter is ignored. + * @param boolean $conf This parameter is ignored. + * @param boolean $level This parameter is ignored. + * + * @access public + */ + function Log_composite($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_ident = $ident; + } + + /** + * Opens all of the child instances. + * + * @return True if all of the child instances were successfully opened. + * + * @access public + */ + function open() + { + /* Attempt to open each of our children. */ + $this->_opened = true; + foreach ($this->_children as $id => $child) { + $this->_opened &= $this->_children[$id]->open(); + } + + /* If all children were opened, return success. */ + return $this->_opened; + } + + /** + * Closes all of the child instances. + * + * @return True if all of the child instances were successfully closed. + * + * @access public + */ + function close() + { + /* Attempt to close each of our children. */ + $closed = true; + foreach ($this->_children as $id => $child) { + $closed &= $this->_children[$id]->close(); + } + + /* Track the _opened state for consistency. */ + $this->_opened = false; + + /* If all children were closed, return success. */ + return $closed; + } + + /** + * Flushes all child instances. It is assumed that all of the children + * have been successfully opened. + * + * @return True if all of the child instances were successfully flushed. + * + * @access public + * @since Log 1.8.2 + */ + function flush() + { + /* Attempt to flush each of our children. */ + $flushed = true; + foreach ($this->_children as $id => $child) { + $flushed &= $this->_children[$id]->flush(); + } + + /* If all children were flushed, return success. */ + return $flushed; + } + + /** + * Sends $message and $priority to each child of this composite. If the + * children aren't already open, they will be opened here. + * + * @param mixed $message String or object containing the message + * to log. + * @param string $priority (optional) 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 if the entry is successfully logged. + * + * @access public + */ + function log($message, $priority = null) + { + /* If a priority hasn't been specified, use the default value. */ + if ($priority === null) { + $priority = $this->_priority; + } + + /* + * If the handlers haven't been opened, attempt to open them now. + * However, we don't treat failure to open all of the handlers as a + * fatal error. We defer that consideration to the success of calling + * each handler's log() method below. + */ + if (!$this->_opened) { + $this->open(); + } + + /* Attempt to log the event using each of the children. */ + $success = true; + foreach ($this->_children as $id => $child) { + $success &= $this->_children[$id]->log($message, $priority); + } + + $this->_announce(array('priority' => $priority, 'message' => $message)); + + /* Return success if all of the children logged the event. */ + return $success; + } + + /** + * Returns true if this is a composite. + * + * @return boolean True if this is a composite class. + * + * @access public + */ + function isComposite() + { + return true; + } + + /** + * Sets this identification string for all of this composite's children. + * + * @param string $ident The new identification string. + * + * @access public + * @since Log 1.6.7 + */ + function setIdent($ident) + { + /* Call our base class's setIdent() method. */ + parent::setIdent($ident); + + /* ... and then call setIdent() on all of our children. */ + foreach ($this->_children as $id => $child) { + $this->_children[$id]->setIdent($ident); + } + } + + /** + * Adds a Log instance to the list of children. + * + * @param object $child The Log instance to add. + * + * @return boolean True if the Log instance was successfully added. + * + * @access public + */ + function addChild(&$child) + { + /* Make sure this is a Log instance. */ + if (!is_a($child, 'Log')) { + return false; + } + + $this->_children[$child->_id] = &$child; + + return true; + } + + /** + * Removes a Log instance from the list of children. + * + * @param object $child The Log instance to remove. + * + * @return boolean True if the Log instance was successfully removed. + * + * @access public + */ + function removeChild($child) + { + if (!is_a($child, 'Log') || !isset($this->_children[$child->_id])) { + return false; + } + + unset($this->_children[$child->_id]); + + return true; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/console.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/console.php --- php-log-1.9.11/Log-1.9.16/Log/console.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/console.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,208 @@ + + * @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 = STDOUT; + + /** + * 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'; + + /** + * 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'])) { + $this->_stream = $conf['stream']; + } + + 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->close(); + } + + /** + * Open the output stream. + * + * @access public + * @since Log 1.9.7 + */ + function open() + { + $this->_opened = true; + return true; + } + + /** + * Closes the output stream. + * + * This results in a call to flush(). + * + * @access public + * @since Log 1.9.0 + */ + function close() + { + $this->flush(); + $this->_opened = false; + return true; + } + + /** + * 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 = ''; + } + + if (is_resource($this->_stream)) { + return fflush($this->_stream); + } + + return false; + } + + /** + * 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 = $this->_format($this->_lineFormat, + strftime($this->_timeFormat), + $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; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/daemon.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/daemon.php --- php-log-1.9.11/Log-1.9.16/Log/daemon.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/daemon.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,235 @@ + + * @version $Revision: 1.3 $ + * @package Log + */ +class Log_daemon extends Log +{ + /** + * Integer holding the log facility to use. + * @var string + */ + var $_name = LOG_DAEMON; + + /** + * Var holding the resource pointer to the socket + * @var resource + */ + var $_socket; + + /** + * The ip address or servername + * @see http://www.php.net/manual/en/transports.php + * @var string + */ + var $_ip = '127.0.0.1'; + + /** + * Protocol to use (tcp, udp, etc.) + * @see http://www.php.net/manual/en/transports.php + * @var string + */ + var $_proto = 'udp'; + + /** + * Port to connect to + * @var int + */ + var $_port = 514; + + /** + * Maximum message length in bytes + * @var int + */ + var $_maxsize = 4096; + + /** + * Socket timeout in seconds + * @var int + */ + var $_timeout = 1; + + + /** + * Constructs a new syslog object. + * + * @param string $name The syslog facility. + * @param string $ident The identity string. + * @param array $conf The configuration array. + * @param int $maxLevel Maximum level at which to log. + * @access public + */ + function Log_daemon($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + /* Ensure we have a valid integer value for $name. */ + if (empty($name) || !is_int($name)) { + $name = LOG_SYSLOG; + } + + $this->_id = md5(microtime()); + $this->_name = $name; + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + + if (isset($conf['ip'])) { + $this->_ip = $conf['ip']; + } + if (isset($conf['proto'])) { + $this->_proto = $conf['proto']; + } + if (isset($conf['port'])) { + $this->_port = $conf['port']; + } + if (isset($conf['maxsize'])) { + $this->_maxsize = $conf['maxsize']; + } + if (isset($conf['timeout'])) { + $this->_timeout = $conf['timeout']; + } + $this->_proto = $this->_proto . '://'; + + register_shutdown_function(array(&$this, '_Log_daemon')); + } + + /** + * Destructor. + * + * @access private + */ + function _Log_daemon() + { + $this->close(); + } + + /** + * Opens a connection to the system logger, if it has not already + * been opened. This is implicitly called by log(), if necessary. + * @access public + */ + function open() + { + if (!$this->_opened) { + $this->_opened = (bool)($this->_socket = @fsockopen( + $this->_proto . $this->_ip, + $this->_port, + $errno, + $errstr, + $this->_timeout)); + } + return $this->_opened; + } + + /** + * Closes the connection to the system logger, if it is open. + * @access public + */ + function close() + { + if ($this->_opened) { + $this->_opened = false; + return fclose($this->_socket); + } + return true; + } + + /** + * Sends $message to the currently open syslog connection. Calls + * open() if necessary. Also passes the message along to any Log_observer + * instances that are observing this Log. + * + * @param string $message The textual message to be logged. + * @param int $priority (optional) The priority of the message. Valid + * values are: LOG_EMERG, LOG_ALERT, LOG_CRIT, + * LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, + * and LOG_DEBUG. The default is LOG_INFO. + * @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; + } + + /* If the connection isn't open and can't be opened, return failure. */ + if (!$this->_opened && !$this->open()) { + return false; + } + + /* Extract the string representation of the message. */ + $message = $this->_extractMessage($message); + + /* Set the facility level. */ + $facility_level = intval($this->_name) + + intval($this->_toSyslog($priority)); + + /* Prepend ident info. */ + if (!empty($this->_ident)) { + $message = $this->_ident . ' ' . $message; + } + + /* Check for message length. */ + if (strlen($message) > $this->_maxsize) { + $message = substr($message, 0, ($this->_maxsize) - 10) . ' [...]'; + } + + /* Write to socket. */ + fwrite($this->_socket, '<' . $facility_level . '>' . $message . "\n"); + + $this->_announce(array('priority' => $priority, 'message' => $message)); + } + + /** + * Converts a PEAR_LOG_* constant into a syslog LOG_* constant. + * + * This function exists because, under Windows, not all of the LOG_* + * constants have unique values. Instead, the PEAR_LOG_* were introduced + * for global use, with the conversion to the LOG_* constants kept local to + * to the syslog driver. + * + * @param int $priority PEAR_LOG_* value to convert to LOG_* value. + * + * @return The LOG_* representation of $priority. + * + * @access private + */ + function _toSyslog($priority) + { + static $priorities = array( + PEAR_LOG_EMERG => LOG_EMERG, + PEAR_LOG_ALERT => LOG_ALERT, + PEAR_LOG_CRIT => LOG_CRIT, + PEAR_LOG_ERR => LOG_ERR, + PEAR_LOG_WARNING => LOG_WARNING, + PEAR_LOG_NOTICE => LOG_NOTICE, + PEAR_LOG_INFO => LOG_INFO, + PEAR_LOG_DEBUG => LOG_DEBUG + ); + + /* If we're passed an unknown priority, default to LOG_INFO. */ + if (!is_int($priority) || !in_array($priority, $priorities)) { + return LOG_INFO; + } + + return $priorities[$priority]; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/display.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/display.php --- php-log-1.9.11/Log-1.9.16/Log/display.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/display.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,159 @@ + + * @since Log 1.8.0 + * @package Log + * + * @example display.php Using the display handler. + */ +class Log_display extends Log +{ + /** + * String containing the format of a log line. + * @var string + * @access private + */ + var $_lineFormat = '%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'; + + /** + * Constructs a new Log_display 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_display($name = '', $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + + /* Start by configuring the line format. */ + if (!empty($conf['lineFormat'])) { + $this->_lineFormat = str_replace(array_keys($this->_formatMap), + array_values($this->_formatMap), + $conf['lineFormat']); + } + + /* We may need to prepend a string to our line format. */ + $prepend = null; + if (isset($conf['error_prepend'])) { + $prepend = $conf['error_prepend']; + } else { + $prepend = ini_get('error_prepend_string'); + } + if (!empty($prepend)) { + $this->_lineFormat = $prepend . $this->_lineFormat; + } + + /* We may also need to append a string to our line format. */ + $append = null; + if (isset($conf['error_append'])) { + $append = $conf['error_append']; + } else { + $append = ini_get('error_append_string'); + } + if (!empty($append)) { + $this->_lineFormat .= $append; + } + + /* Lastly, the line ending sequence is also configurable. */ + if (isset($conf['linebreak'])) { + $this->_lineFormat .= $conf['linebreak']; + } + + /* The user can also change the time format. */ + if (!empty($conf['timeFormat'])) { + $this->_timeFormat = $conf['timeFormat']; + } + } + + /** + * Opens the display handler. + * + * @access public + * @since Log 1.9.6 + */ + function open() + { + $this->_opened = true; + return true; + } + + /** + * Closes the display handler. + * + * @access public + * @since Log 1.9.6 + */ + function close() + { + $this->_opened = false; + return true; + } + + /** + * Writes $message to the text browser. 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 and output the complete log line. */ + echo $this->_format($this->_lineFormat, + strftime($this->_timeFormat), + $priority, + nl2br(htmlspecialchars($message))); + + /* Notify observers about this log message. */ + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/error_log.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/error_log.php --- php-log-1.9.11/Log-1.9.16/Log/error_log.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/error_log.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,127 @@ + + * @since Log 1.7.0 + * @package Log + * + * @example error_log.php Using the error_log handler. + */ +class Log_error_log extends Log +{ + /** + * The error_log() log type. + * @var integer + * @access private + */ + var $_type = PEAR_LOG_TYPE_SYSTEM; + + /** + * The type-specific destination value. + * @var string + * @access private + */ + var $_destination = ''; + + /** + * Additional headers to pass to the mail() function when the + * PEAR_LOG_TYPE_MAIL type is used. + * @var string + * @access private + */ + var $_extra_headers = ''; + + /** + * Constructs a new Log_error_log 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_error_log($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_type = $name; + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + + if (!empty($conf['destination'])) { + $this->_destination = $conf['destination']; + } + if (!empty($conf['extra_headers'])) { + $this->_extra_headers = $conf['extra_headers']; + } + } + + /** + * Opens the handler. + * + * @access public + * @since Log 1.9.6 + */ + function open() + { + $this->_opened = true; + return true; + } + + /** + * Closes the handler. + * + * @access public + * @since Log 1.9.6 + */ + function close() + { + $this->_opened = false; + return true; + } + + /** + * Logs $message using PHP's error_log() function. 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); + + $success = error_log($this->_ident . ': ' . $message, $this->_type, + $this->_destination, $this->_extra_headers); + + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return $success; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/file.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/file.php --- php-log-1.9.11/Log-1.9.16/Log/file.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/file.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,316 @@ + + * @author Roman Neuhauser + * @since Log 1.0 + * @package Log + * + * @example file.php Using the file handler. + */ +class Log_file extends Log +{ + /** + * String containing the name of the log file. + * @var string + * @access private + */ + var $_filename = 'php.log'; + + /** + * Handle to the log file. + * @var resource + * @access private + */ + var $_fp = false; + + /** + * Should new log entries be append to an existing log file, or should the + * a new log file overwrite an existing one? + * @var boolean + * @access private + */ + var $_append = true; + + /** + * Should advisory file locking (i.e., flock()) be used? + * @var boolean + * @access private + */ + var $_locking = false; + + /** + * Integer (in octal) containing the log file's permissions mode. + * @var integer + * @access private + */ + var $_mode = 0644; + + /** + * Integer (in octal) specifying the file permission mode that will be + * used when creating directories that do not already exist. + * @var integer + * @access private + */ + var $_dirmode = 0755; + + /** + * 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'; + + /** + * String containing the end-on-line character sequence. + * @var string + * @access private + */ + var $_eol = "\n"; + + /** + * Constructs a new Log_file 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_file($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_filename = $name; + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + + if (isset($conf['append'])) { + $this->_append = $conf['append']; + } + + if (isset($conf['locking'])) { + $this->_locking = $conf['locking']; + } + + if (!empty($conf['mode'])) { + if (is_string($conf['mode'])) { + $this->_mode = octdec($conf['mode']); + } else { + $this->_mode = $conf['mode']; + } + } + + if (!empty($conf['dirmode'])) { + if (is_string($conf['dirmode'])) { + $this->_dirmode = octdec($conf['dirmode']); + } else { + $this->_dirmode = $conf['dirmode']; + } + } + + 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 (!empty($conf['eol'])) { + $this->_eol = $conf['eol']; + } else { + $this->_eol = (strstr(PHP_OS, 'WIN')) ? "\r\n" : "\n"; + } + + register_shutdown_function(array(&$this, '_Log_file')); + } + + /** + * Destructor + */ + function _Log_file() + { + if ($this->_opened) { + $this->close(); + } + } + + /** + * Creates the given directory path. If the parent directories don't + * already exist, they will be created, too. + * + * This implementation is inspired by Python's os.makedirs function. + * + * @param string $path The full directory path to create. + * @param integer $mode The permissions mode with which the + * directories will be created. + * + * @return True if the full path is successfully created or already + * exists. + * + * @access private + */ + function _mkpath($path, $mode = 0700) + { + /* Separate the last pathname component from the rest of the path. */ + $head = dirname($path); + $tail = basename($path); + + /* Make sure we've split the path into two complete components. */ + if (empty($tail)) { + $head = dirname($path); + $tail = basename($path); + } + + /* Recurse up the path if our current segment does not exist. */ + if (!empty($head) && !empty($tail) && !is_dir($head)) { + $this->_mkpath($head, $mode); + } + + /* Create this segment of the path. */ + return @mkdir($head, $mode); + } + + /** + * Opens the log file for output. If the specified log file does not + * already exist, it will be created. By default, new log entries are + * appended to the end of the log file. + * + * This is implicitly called by log(), if necessary. + * + * @access public + */ + function open() + { + if (!$this->_opened) { + /* If the log file's directory doesn't exist, create it. */ + if (!is_dir(dirname($this->_filename))) { + $this->_mkpath($this->_filename, $this->_dirmode); + } + + /* Determine whether the log file needs to be created. */ + $creating = !file_exists($this->_filename); + + /* Obtain a handle to the log file. */ + $this->_fp = fopen($this->_filename, ($this->_append) ? 'a' : 'w'); + + /* We consider the file "opened" if we have a valid file pointer. */ + $this->_opened = ($this->_fp !== false); + + /* Attempt to set the file's permissions if we just created it. */ + if ($creating && $this->_opened) { + chmod($this->_filename, $this->_mode); + } + } + + return $this->_opened; + } + + /** + * Closes the log file if it is open. + * + * @access public + */ + function close() + { + /* If the log file is open, close it. */ + if ($this->_opened && fclose($this->_fp)) { + $this->_opened = false; + } + + return ($this->_opened === false); + } + + /** + * Flushes all pending data to the file handle. + * + * @access public + * @since Log 1.8.2 + */ + function flush() + { + if (is_resource($this->_fp)) { + return fflush($this->_fp); + } + + return false; + } + + /** + * 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; + } + + /* If the log file isn't already open, open it now. */ + if (!$this->_opened && !$this->open()) { + return false; + } + + /* Extract the string representation of the message. */ + $message = $this->_extractMessage($message); + + /* Build the string containing the complete log line. */ + $line = $this->_format($this->_lineFormat, + strftime($this->_timeFormat), + $priority, $message) . $this->_eol; + + /* If locking is enabled, acquire an exclusive lock on the file. */ + if ($this->_locking) { + flock($this->_fp, LOCK_EX); + } + + /* Write the log line to the log file. */ + $success = (fwrite($this->_fp, $line) !== false); + + /* Unlock the file now that we're finished writing to it. */ + if ($this->_locking) { + flock($this->_fp, LOCK_UN); + } + + /* Notify observers about this log message. */ + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return $success; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/firebug.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/firebug.php --- php-log-1.9.11/Log-1.9.16/Log/firebug.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/firebug.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,214 @@ + + * @since Log 1.9.11 + * @package Log + * + * @example firebug.php Using the firebug handler. + */ +class Log_firebug extends Log +{ + /** + * 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 = array(); + + /** + * String containing the format of a log line. + * @var string + * @access private + */ + var $_lineFormat = '%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. + * + * Note! Default lineFormat of this driver does not display time. + * + * @var string + * @access private + */ + var $_timeFormat = '%b %d %H:%M:%S'; + + /** + * Mapping of log priorities to Firebug methods. + * @var array + * @access private + */ + var $_methods = array( + PEAR_LOG_EMERG => 'error', + PEAR_LOG_ALERT => 'error', + PEAR_LOG_CRIT => 'error', + PEAR_LOG_ERR => 'error', + PEAR_LOG_WARNING => 'warn', + PEAR_LOG_NOTICE => 'info', + PEAR_LOG_INFO => 'info', + PEAR_LOG_DEBUG => 'debug' + ); + + /** + * Constructs a new Log_firebug 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_firebug($name = '', $ident = 'PHP', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + if (isset($conf['buffering'])) { + $this->_buffering = $conf['buffering']; + } + + if ($this->_buffering) { + register_shutdown_function(array(&$this, '_Log_firebug')); + } + + 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']; + } + } + + /** + * Opens the firebug handler. + * + * @access public + */ + function open() + { + $this->_opened = true; + return true; + } + + /** + * Destructor + */ + function _Log_firebug() + { + $this->close(); + } + + /** + * Closes the firebug handler. + * + * @access public + */ + function close() + { + $this->flush(); + $this->_opened = false; + return true; + } + + /** + * Flushes all pending ("buffered") data. + * + * @access public + */ + function flush() { + if (count($this->_buffer)) { + print '\n"; + }; + $this->_buffer = array(); + } + + /** + * Writes $message to Firebug 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); + $method = $this->_methods[$priority]; + + /* normalize line breaks */ + $message = str_replace("\r\n", "\n", $message); + + /* escape line breaks */ + $message = str_replace("\n", "\\n\\\n", $message); + + /* escape quotes */ + $message = str_replace('"', '\\"', $message); + + /* Build the string containing the complete log line. */ + $line = $this->_format($this->_lineFormat, + strftime($this->_timeFormat), + $priority, + $message); + + if ($this->_buffering) { + $this->_buffer[] = sprintf('console.%s("%s");', $method, $line); + } else { + print '\n"; + } + /* Notify observers about this log message. */ + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/mail.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/mail.php --- php-log-1.9.11/Log-1.9.16/Log/mail.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/mail.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,257 @@ + + * @author Jon Parise + * @since Log 1.3 + * @package Log + * + * @example mail.php Using the mail handler. + */ +class Log_mail extends Log +{ + /** + * String holding the recipients' email addresses. Multiple addresses + * should be separated with commas. + * @var string + * @access private + */ + var $_recipients = ''; + + /** + * String holding the sender's email address. + * @var string + * @access private + */ + var $_from = ''; + + /** + * String holding the email's subject. + * @var string + * @access private + */ + var $_subject = '[Log_mail] Log message'; + + /** + * String holding an optional preamble for the log messages. + * @var string + * @access private + */ + var $_preamble = ''; + + /** + * 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'; + + /** + * String holding the mail message body. + * @var string + * @access private + */ + var $_message = ''; + + /** + * Flag used to indicated that log lines have been written to the message + * body and the message should be sent on close(). + * @var boolean + * @access private + */ + var $_shouldSend = false; + + /** + * Constructs a new Log_mail object. + * + * Here is how you can customize the mail driver with the conf[] hash : + * $conf['from'] : the mail's "From" header line, + * $conf['subject'] : the mail's "Subject" line. + * + * @param string $name The message's recipients. + * @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_mail($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_recipients = $name; + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + + if (!empty($conf['from'])) { + $this->_from = $conf['from']; + } else { + $this->_from = ini_get('sendmail_from'); + } + + if (!empty($conf['subject'])) { + $this->_subject = $conf['subject']; + } + + if (!empty($conf['preamble'])) { + $this->_preamble = $conf['preamble']; + } + + 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']; + } + + /* register the destructor */ + register_shutdown_function(array(&$this, '_Log_mail')); + } + + /** + * Destructor. Calls close(). + * + * @access private + */ + function _Log_mail() + { + $this->close(); + } + + /** + * Starts a new mail message. + * This is implicitly called by log(), if necessary. + * + * @access public + */ + function open() + { + if (!$this->_opened) { + if (!empty($this->_preamble)) { + $this->_message = $this->_preamble . "\r\n\r\n"; + } + $this->_opened = true; + $_shouldSend = false; + } + + return $this->_opened; + } + + /** + * Closes the message, if it is open, and sends the mail. + * This is implicitly called by the destructor, if necessary. + * + * @access public + */ + function close() + { + if ($this->_opened) { + if ($this->_shouldSend && !empty($this->_message)) { + $headers = "From: $this->_from\r\n"; + $headers .= "User-Agent: Log_mail"; + + if (mail($this->_recipients, $this->_subject, $this->_message, + $headers) == false) { + error_log("Log_mail: Failure executing mail()", 0); + return false; + } + + /* Clear the message string now that the email has been sent. */ + $this->_message = ''; + $this->_shouldSend = false; + } + $this->_opened = false; + } + + return ($this->_opened === false); + } + + /** + * Flushes the log output by forcing the email message to be sent now. + * Events that are logged after flush() is called will be appended to a + * new email message. + * + * @access public + * @since Log 1.8.2 + */ + function flush() + { + /* + * It's sufficient to simply call close() to flush the output. + * The next call to log() will cause the handler to be reopened. + */ + return $this->close(); + } + + /** + * Writes $message to the currently open mail message. + * Calls open(), if necessary. + * + * @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; + } + + /* If the message isn't open and can't be opened, return failure. */ + if (!$this->_opened && !$this->open()) { + return false; + } + + /* Extract the string representation of the message. */ + $message = $this->_extractMessage($message); + + /* Append the string containing the complete log line. */ + $this->_message .= $this->_format($this->_lineFormat, + strftime($this->_timeFormat), + $priority, $message) . "\r\n"; + $this->_shouldSend = true; + + /* Notify observers about this log message. */ + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/mcal.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/mcal.php --- php-log-1.9.11/Log-1.9.16/Log/mcal.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/mcal.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,170 @@ + + * @since Horde 1.3 + * @since Log 1.0 + * @package Log + */ +class Log_mcal extends Log +{ + /** + * holding the calendar specification to connect to. + * @var string + * @access private + */ + var $_calendar = '{localhost/mstore}'; + + /** + * holding the username to use. + * @var string + * @access private + */ + var $_username = ''; + + /** + * holding the password to use. + * @var string + * @access private + */ + var $_password = ''; + + /** + * holding the options to pass to the calendar stream. + * @var integer + * @access private + */ + var $_options = 0; + + /** + * ResourceID of the MCAL stream. + * @var string + * @access private + */ + var $_stream = ''; + + /** + * Integer holding the log facility to use. + * @var string + * @access private + */ + var $_name = LOG_SYSLOG; + + + /** + * Constructs a new Log_mcal object. + * + * @param string $name The category to use for our events. + * @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_mcal($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_name = $name; + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + $this->_calendar = $conf['calendar']; + $this->_username = $conf['username']; + $this->_password = $conf['password']; + $this->_options = $conf['options']; + } + + /** + * Opens a calendar stream, if it has not already been + * opened. This is implicitly called by log(), if necessary. + * @access public + */ + function open() + { + if (!$this->_opened) { + $this->_stream = mcal_open($this->_calendar, $this->_username, + $this->_password, $this->_options); + $this->_opened = true; + } + + return $this->_opened; + } + + /** + * Closes the calendar stream, if it is open. + * @access public + */ + function close() + { + if ($this->_opened) { + mcal_close($this->_stream); + $this->_opened = false; + } + + return ($this->_opened === false); + } + + /** + * Logs $message and associated information to the currently open + * calendar stream. Calls open() if necessary. 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; + } + + /* If the connection isn't open and can't be opened, return failure. */ + if (!$this->_opened && !$this->open()) { + return false; + } + + /* Extract the string representation of the message. */ + $message = $this->_extractMessage($message); + + $date_str = date('Y:n:j:G:i:s'); + $dates = explode(':', $date_str); + + mcal_event_init($this->_stream); + mcal_event_set_title($this->_stream, $this->_ident); + mcal_event_set_category($this->_stream, $this->_name); + mcal_event_set_description($this->_stream, $message); + mcal_event_add_attribute($this->_stream, 'priority', $priority); + mcal_event_set_start($this->_stream, $dates[0], $dates[1], $dates[2], + $dates[3], $dates[4], $dates[5]); + mcal_event_set_end($this->_stream, $dates[0], $dates[1], $dates[2], + $dates[3], $dates[4], $dates[5]); + mcal_append_event($this->_stream); + + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/mdb2.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/mdb2.php --- php-log-1.9.11/Log-1.9.16/Log/mdb2.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/mdb2.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,358 @@ + + * @author Jon Parise + * @since Log 1.9.0 + * @package Log + */ +class Log_mdb2 extends Log +{ + /** + * Variable containing the DSN information. + * @var mixed + * @access private + */ + var $_dsn = ''; + + /** + * Array containing our set of DB configuration options. + * @var array + * @access private + */ + var $_options = array('persistent' => true); + + /** + * Object holding the database handle. + * @var object + * @access private + */ + var $_db = null; + + /** + * Resource holding the prepared statement handle. + * @var resource + * @access private + */ + var $_statement = null; + + /** + * Flag indicating that we're using an existing database connection. + * @var boolean + * @access private + */ + var $_existingConnection = false; + + /** + * String holding the database table to use. + * @var string + * @access private + */ + var $_table = 'log_table'; + + /** + * String holding the name of the ID sequence. + * @var string + * @access private + */ + var $_sequence = 'log_id'; + + /** + * Maximum length of the $ident string. This corresponds to the size of + * the 'ident' column in the SQL table. + * @var integer + * @access private + */ + var $_identLimit = 16; + + /** + * Set of field types used in the database table. + * @var array + * @access private + */ + var $_types = array( + 'id' => 'integer', + 'logtime' => 'timestamp', + 'ident' => 'text', + 'priority' => 'text', + 'message' => 'clob' + ); + + /** + * Constructs a new sql logging object. + * + * @param string $name The target SQL table. + * @param string $ident The identification field. + * @param array $conf The connection configuration array. + * @param int $level Log messages up to and including this level. + * @access public + */ + function Log_mdb2($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_table = $name; + $this->_mask = Log::UPTO($level); + + /* If an options array was provided, use it. */ + if (isset($conf['options']) && is_array($conf['options'])) { + $this->_options = $conf['options']; + } + + /* If a specific sequence name was provided, use it. */ + if (!empty($conf['sequence'])) { + $this->_sequence = $conf['sequence']; + } + + /* If a specific sequence name was provided, use it. */ + if (isset($conf['identLimit'])) { + $this->_identLimit = $conf['identLimit']; + } + + /* Now that the ident limit is confirmed, set the ident string. */ + $this->setIdent($ident); + + /* If an existing database connection was provided, use it. */ + if (isset($conf['db'])) { + $this->_db = &$conf['db']; + $this->_existingConnection = true; + $this->_opened = true; + } elseif (isset($conf['singleton'])) { + $this->_db = &MDB2::singleton($conf['singleton'], $this->_options); + $this->_existingConnection = true; + $this->_opened = true; + } else { + $this->_dsn = $conf['dsn']; + } + } + + /** + * Opens a connection to the database, if it has not already + * been opened. This is implicitly called by log(), if necessary. + * + * @return boolean True on success, false on failure. + * @access public + */ + function open() + { + if (!$this->_opened) { + /* Use the DSN and options to create a database connection. */ + $this->_db = &MDB2::connect($this->_dsn, $this->_options); + if (PEAR::isError($this->_db)) { + return false; + } + + /* Create a prepared statement for repeated use in log(). */ + if (!$this->_prepareStatement()) { + return false; + } + + /* We now consider out connection open. */ + $this->_opened = true; + } + + return $this->_opened; + } + + /** + * Closes the connection to the database if it is still open and we were + * the ones that opened it. It is the caller's responsible to close an + * existing connection that was passed to us via $conf['db']. + * + * @return boolean True on success, false on failure. + * @access public + */ + function close() + { + /* If we have a statement object, free it. */ + if (is_object($this->_statement)) { + $this->_statement->free(); + $this->_statement = null; + } + + /* If we opened the database connection, disconnect it. */ + if ($this->_opened && !$this->_existingConnection) { + $this->_opened = false; + return $this->_db->disconnect(); + } + + return ($this->_opened === false); + } + + /** + * Sets this Log instance's identification string. Note that this + * SQL-specific implementation will limit the length of the $ident string + * to sixteen (16) characters. + * + * @param string $ident The new identification string. + * + * @access public + * @since Log 1.8.5 + */ + function setIdent($ident) + { + $this->_ident = substr($ident, 0, $this->_identLimit); + } + + /** + * Inserts $message to the currently open database. Calls open(), + * if necessary. 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; + } + + /* If the connection isn't open and can't be opened, return failure. */ + if (!$this->_opened && !$this->open()) { + return false; + } + + /* If we don't already have a statement object, create one. */ + if (!is_object($this->_statement) && !$this->_prepareStatement()) { + return false; + } + + /* Extract the string representation of the message. */ + $message = $this->_extractMessage($message); + + /* Build our set of values for this log entry. */ + $values = array( + 'id' => $this->_db->nextId($this->_sequence), + 'logtime' => MDB2_Date::mdbNow(), + 'ident' => $this->_ident, + 'priority' => $priority, + 'message' => $message + ); + + /* Execute the SQL query for this log entry insertion. */ + $this->_db->expectError(MDB2_ERROR_NOSUCHTABLE); + $result = &$this->_statement->execute($values); + $this->_db->popExpect(); + + /* Attempt to handle any errors. */ + if (PEAR::isError($result)) { + /* We can only handle MDB2_ERROR_NOSUCHTABLE errors. */ + if ($result->getCode() != MDB2_ERROR_NOSUCHTABLE) { + return false; + } + + /* Attempt to create the target table. */ + if (!$this->_createTable()) { + return false; + } + + /* Recreate our prepared statement resource. */ + $this->_statement->free(); + if (!$this->_prepareStatement()) { + return false; + } + + /* Attempt to re-execute the insertion query. */ + $result = $this->_statement->execute($values); + if (PEAR::isError($result)) { + return false; + } + } + + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + + /** + * Create the log table in the database. + * + * @return boolean True on success or false on failure. + * @access private + */ + function _createTable() + { + $this->_db->loadModule('Manager', null, true); + $result = $this->_db->manager->createTable( + $this->_table, + array( + 'id' => array('type' => $this->_types['id']), + 'logtime' => array('type' => $this->_types['logtime']), + 'ident' => array('type' => $this->_types['ident']), + 'priority' => array('type' => $this->_types['priority']), + 'message' => array('type' => $this->_types['message']) + ) + ); + if (PEAR::isError($result)) { + return false; + } + + $result = $this->_db->manager->createIndex( + $this->_table, + 'unique_id', + array('fields' => array('id' => true), 'unique' => true) + ); + if (PEAR::isError($result)) { + return false; + } + + return true; + } + + /** + * Prepare the SQL insertion statement. + * + * @return boolean True if the statement was successfully created. + * + * @access private + * @since Log 1.9.0 + */ + function _prepareStatement() + { + $this->_statement = &$this->_db->prepare( + 'INSERT INTO ' . $this->_table . + ' (id, logtime, ident, priority, message)' . + ' VALUES(:id, :logtime, :ident, :priority, :message)', + $this->_types, MDB2_PREPARE_MANIP); + + /* Return success if we didn't generate an error. */ + return (PEAR::isError($this->_statement) === false); + } +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/null.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/null.php --- php-log-1.9.11/Log-1.9.16/Log/null.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/null.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,91 @@ + + * @since Log 1.8.2 + * @package Log + * + * @example null.php Using the null handler. + */ +class Log_null extends Log +{ + /** + * Constructs a new Log_null 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_null($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + } + + /** + * Opens the handler. + * + * @access public + * @since Log 1.9.6 + */ + function open() + { + $this->_opened = true; + return true; + } + + /** + * Closes the handler. + * + * @access public + * @since Log 1.9.6 + */ + function close() + { + $this->_opened = false; + return true; + } + + /** + * Simply consumes the log event. The message will still be 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; + } + + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/observer.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/observer.php --- php-log-1.9.11/Log-1.9.16/Log/observer.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/observer.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,129 @@ + + * @since Horde 1.3 + * @since Log 1.0 + * @package Log + * + * @example observer_mail.php An example Log_observer implementation. + */ +class Log_observer +{ + /** + * Instance-specific unique identification number. + * + * @var integer + * @access private + */ + var $_id = 0; + + /** + * The minimum priority level of message that we want to hear about. + * PEAR_LOG_EMERG is the highest priority, so we will only hear messages + * with an integer priority value less than or equal to ours. It defaults + * to PEAR_LOG_INFO, which listens to everything except PEAR_LOG_DEBUG. + * + * @var string + * @access private + */ + var $_priority = PEAR_LOG_INFO; + + /** + * Creates a new basic Log_observer instance. + * + * @param integer $priority The highest priority at which to receive + * log event notifications. + * + * @access public + */ + function Log_observer($priority = PEAR_LOG_INFO) + { + $this->_id = md5(microtime()); + $this->_priority = $priority; + } + + /** + * Attempts to return a new concrete Log_observer instance of the requested + * type. + * + * @param string $type The type of concreate Log_observer subclass + * to return. + * @param integer $priority The highest priority at which to receive + * log event notifications. + * @param array $conf Optional associative array of additional + * configuration values. + * + * @return object The newly created concrete Log_observer + * instance, or null on an error. + */ + function &factory($type, $priority = PEAR_LOG_INFO, $conf = array()) + { + $type = strtolower($type); + $class = 'Log_observer_' . $type; + + /* + * If the desired class already exists (because the caller has supplied + * it from some custom location), simply instantiate and return a new + * instance. + */ + if (class_exists($class)) { + $object = &new $class($priority, $conf); + return $object; + } + + /* Support both the new-style and old-style file naming conventions. */ + $newstyle = true; + $classfile = dirname(__FILE__) . '/observer_' . $type . '.php'; + + if (!file_exists($classfile)) { + $classfile = 'Log/' . $type . '.php'; + $newstyle = false; + } + + /* + * Attempt to include our version of the named class, but don't treat + * a failure as fatal. The caller may have already included their own + * version of the named class. + */ + @include_once $classfile; + + /* If the class exists, return a new instance of it. */ + if (class_exists($class)) { + /* Support both new-style and old-style construction. */ + if ($newstyle) { + $object = &new $class($priority, $conf); + } else { + $object = &new $class($priority); + } + return $object; + } + + $null = null; + return $null; + } + + /** + * This is a stub method to make sure that Log_Observer classes do + * something when they are notified of a message. The default behavior + * is to just print the message, which is obviously not desireable in + * practically any situation - which is why you need to override this + * method. :) + * + * @param array $event A hash describing the log event. + */ + function notify($event) + { + print_r($event); + } +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/sqlite.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/sqlite.php --- php-log-1.9.11/Log-1.9.16/Log/sqlite.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/sqlite.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,225 @@ + + * @author Jon Parise + * @since Log 1.8.3 + * @package Log + * + * @example sqlite.php Using the Sqlite handler. + */ +class Log_sqlite extends Log +{ + /** + * Array containing the connection defaults + * @var array + * @access private + */ + var $_options = array('mode' => 0666, + 'persistent' => false); + + /** + * Object holding the database handle. + * @var object + * @access private + */ + var $_db = null; + + /** + * Flag indicating that we're using an existing database connection. + * @var boolean + * @access private + */ + var $_existingConnection = false; + + /** + * String holding the database table to use. + * @var string + * @access private + */ + var $_table = 'log_table'; + + + /** + * Constructs a new sql logging object. + * + * @param string $name The target SQL table. + * @param string $ident The identification field. + * @param mixed $conf Can be an array of configuration options used + * to open a new database connection + * or an already opened sqlite connection. + * @param int $level Log messages up to and including this level. + * @access public + */ + function Log_sqlite($name, $ident = '', &$conf, $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_table = $name; + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + + if (is_array($conf)) { + foreach ($conf as $k => $opt) { + $this->_options[$k] = $opt; + } + } else { + // If an existing database connection was provided, use it. + $this->_db =& $conf; + $this->_existingConnection = true; + } + } + + /** + * Opens a connection to the database, if it has not already + * been opened. This is implicitly called by log(), if necessary. + * + * @return boolean True on success, false on failure. + * @access public + */ + function open() + { + if (is_resource($this->_db)) { + $this->_opened = true; + return $this->_createTable(); + } else { + /* Set the connection function based on the 'persistent' option. */ + if (empty($this->_options['persistent'])) { + $connectFunction = 'sqlite_open'; + } else { + $connectFunction = 'sqlite_popen'; + } + + /* Attempt to connect to the database. */ + if ($this->_db = $connectFunction($this->_options['filename'], + (int)$this->_options['mode'], + $error)) { + $this->_opened = true; + return $this->_createTable(); + } + } + + return $this->_opened; + } + + /** + * Closes the connection to the database if it is still open and we were + * the ones that opened it. It is the caller's responsible to close an + * existing connection that was passed to us via $conf['db']. + * + * @return boolean True on success, false on failure. + * @access public + */ + function close() + { + /* We never close existing connections. */ + if ($this->_existingConnection) { + return false; + } + + if ($this->_opened) { + $this->_opened = false; + sqlite_close($this->_db); + } + + return ($this->_opened === false); + } + + /** + * Inserts $message to the currently open database. Calls open(), + * if necessary. 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; + } + + /* If the connection isn't open and can't be opened, return failure. */ + if (!$this->_opened && !$this->open()) { + return false; + } + + // Extract the string representation of the message. + $message = $this->_extractMessage($message); + + // Build the SQL query for this log entry insertion. + $q = sprintf('INSERT INTO [%s] (logtime, ident, priority, message) ' . + "VALUES ('%s', '%s', %d, '%s')", + $this->_table, + strftime('%Y-%m-%d %H:%M:%S', time()), + sqlite_escape_string($this->_ident), + $priority, + sqlite_escape_string($message)); + if (!($res = @sqlite_unbuffered_query($this->_db, $q))) { + return false; + } + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + + /** + * Checks whether the log table exists and creates it if necessary. + * + * @return boolean True on success or false on failure. + * @access private + */ + function _createTable() + { + $q = "SELECT name FROM sqlite_master WHERE name='" . $this->_table . + "' AND type='table'"; + + $res = sqlite_query($this->_db, $q); + + if (sqlite_num_rows($res) == 0) { + $q = 'CREATE TABLE [' . $this->_table . '] (' . + 'id INTEGER PRIMARY KEY NOT NULL, ' . + 'logtime NOT NULL, ' . + 'ident CHAR(16) NOT NULL, ' . + 'priority INT NOT NULL, ' . + 'message)'; + + if (!($res = sqlite_unbuffered_query($this->_db, $q))) { + return false; + } + } + + return true; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/sql.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/sql.php --- php-log-1.9.11/Log-1.9.16/Log/sql.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/sql.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,294 @@ + + * @since Horde 1.3 + * @since Log 1.0 + * @package Log + * + * @example sql.php Using the SQL handler. + */ +class Log_sql extends Log +{ + /** + * Variable containing the DSN information. + * @var mixed + * @access private + */ + var $_dsn = ''; + + /** + * String containing the SQL insertion statement. + * + * @var string + * @access private + */ + var $_sql = ''; + + /** + * Array containing our set of DB configuration options. + * @var array + * @access private + */ + var $_options = array('persistent' => true); + + /** + * Object holding the database handle. + * @var object + * @access private + */ + var $_db = null; + + /** + * Resource holding the prepared statement handle. + * @var resource + * @access private + */ + var $_statement = null; + + /** + * Flag indicating that we're using an existing database connection. + * @var boolean + * @access private + */ + var $_existingConnection = false; + + /** + * String holding the database table to use. + * @var string + * @access private + */ + var $_table = 'log_table'; + + /** + * String holding the name of the ID sequence. + * @var string + * @access private + */ + var $_sequence = 'log_id'; + + /** + * Maximum length of the $ident string. This corresponds to the size of + * the 'ident' column in the SQL table. + * @var integer + * @access private + */ + var $_identLimit = 16; + + + /** + * Constructs a new sql logging object. + * + * @param string $name The target SQL table. + * @param string $ident The identification field. + * @param array $conf The connection configuration array. + * @param int $level Log messages up to and including this level. + * @access public + */ + function Log_sql($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $this->_id = md5(microtime()); + $this->_table = $name; + $this->_mask = Log::UPTO($level); + + /* Now that we have a table name, assign our SQL statement. */ + if (!empty($conf['sql'])) { + $this->_sql = $conf['sql']; + } else { + $this->_sql = 'INSERT INTO ' . $this->_table . + ' (id, logtime, ident, priority, message)' . + ' VALUES(?, CURRENT_TIMESTAMP, ?, ?, ?)'; + } + + /* If an options array was provided, use it. */ + if (isset($conf['options']) && is_array($conf['options'])) { + $this->_options = $conf['options']; + } + + /* If a specific sequence name was provided, use it. */ + if (!empty($conf['sequence'])) { + $this->_sequence = $conf['sequence']; + } + + /* If a specific sequence name was provided, use it. */ + if (isset($conf['identLimit'])) { + $this->_identLimit = $conf['identLimit']; + } + + /* Now that the ident limit is confirmed, set the ident string. */ + $this->setIdent($ident); + + /* If an existing database connection was provided, use it. */ + if (isset($conf['db'])) { + $this->_db = &$conf['db']; + $this->_existingConnection = true; + $this->_opened = true; + } else { + $this->_dsn = $conf['dsn']; + } + } + + /** + * Opens a connection to the database, if it has not already + * been opened. This is implicitly called by log(), if necessary. + * + * @return boolean True on success, false on failure. + * @access public + */ + function open() + { + if (!$this->_opened) { + /* Use the DSN and options to create a database connection. */ + $this->_db = &DB::connect($this->_dsn, $this->_options); + if (DB::isError($this->_db)) { + return false; + } + + /* Create a prepared statement for repeated use in log(). */ + if (!$this->_prepareStatement()) { + return false; + } + + /* We now consider out connection open. */ + $this->_opened = true; + } + + return $this->_opened; + } + + /** + * Closes the connection to the database if it is still open and we were + * the ones that opened it. It is the caller's responsible to close an + * existing connection that was passed to us via $conf['db']. + * + * @return boolean True on success, false on failure. + * @access public + */ + function close() + { + if ($this->_opened && !$this->_existingConnection) { + $this->_opened = false; + $this->_db->freePrepared($this->_statement); + return $this->_db->disconnect(); + } + + return ($this->_opened === false); + } + + /** + * Sets this Log instance's identification string. Note that this + * SQL-specific implementation will limit the length of the $ident string + * to sixteen (16) characters. + * + * @param string $ident The new identification string. + * + * @access public + * @since Log 1.8.5 + */ + function setIdent($ident) + { + $this->_ident = substr($ident, 0, $this->_identLimit); + } + + /** + * Inserts $message to the currently open database. Calls open(), + * if necessary. 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; + } + + /* If the connection isn't open and can't be opened, return failure. */ + if (!$this->_opened && !$this->open()) { + return false; + } + + /* If we don't already have our statement object yet, create it. */ + if (!is_object($this->_statement) && !$this->_prepareStatement()) { + return false; + } + + /* Extract the string representation of the message. */ + $message = $this->_extractMessage($message); + + /* Build our set of values for this log entry. */ + $id = $this->_db->nextId($this->_sequence); + $values = array($id, $this->_ident, $priority, $message); + + /* Execute the SQL query for this log entry insertion. */ + $result =& $this->_db->execute($this->_statement, $values); + if (DB::isError($result)) { + return false; + } + + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + + /** + * Prepare the SQL insertion statement. + * + * @return boolean True if the statement was successfully created. + * + * @access private + * @since Log 1.9.1 + */ + function _prepareStatement() + { + $this->_statement = $this->_db->prepare($this->_sql); + + /* Return success if we didn't generate an error. */ + return (DB::isError($this->_statement) === false); + } +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/syslog.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/syslog.php --- php-log-1.9.11/Log-1.9.16/Log/syslog.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/syslog.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,179 @@ + + * @author Jon Parise + * @since Horde 1.3 + * @since Log 1.0 + * @package Log + * + * @example syslog.php Using the syslog handler. + */ +class Log_syslog extends Log +{ + /** + * Integer holding the log facility to use. + * @var integer + * @access private + */ + var $_name = LOG_SYSLOG; + + /** + * Should we inherit the current syslog connection for this process, or + * should we call openlog() to start a new syslog connection? + * @var boolean + * @access private + */ + var $_inherit = false; + + /** + * Constructs a new syslog object. + * + * @param string $name The syslog facility. + * @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_syslog($name, $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + /* Ensure we have a valid integer value for $name. */ + if (empty($name) || !is_int($name)) { + $name = LOG_SYSLOG; + } + + if (isset($conf['inherit'])) { + $this->_inherit = $conf['inherit']; + $this->_opened = $this->_inherit; + } + + $this->_id = md5(microtime()); + $this->_name = $name; + $this->_ident = $ident; + $this->_mask = Log::UPTO($level); + } + + /** + * Opens a connection to the system logger, if it has not already + * been opened. This is implicitly called by log(), if necessary. + * @access public + */ + function open() + { + if (!$this->_opened) { + $this->_opened = openlog($this->_ident, LOG_PID, $this->_name); + } + + return $this->_opened; + } + + /** + * Closes the connection to the system logger, if it is open. + * @access public + */ + function close() + { + if ($this->_opened && !$this->_inherit) { + closelog(); + $this->_opened = false; + } + + return true; + } + + /** + * Sends $message to the currently open syslog connection. Calls + * open() if necessary. 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 int $priority (optional) 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; + } + + /* If the connection isn't open and can't be opened, return failure. */ + if (!$this->_opened && !$this->open()) { + return false; + } + + /* Extract the string representation of the message. */ + $message = $this->_extractMessage($message); + + /* Build a syslog priority value based on our current configuration. */ + $priority = $this->_toSyslog($priority); + if ($this->_inherit) { + $priority |= $this->_name; + } + + if (!syslog($priority, $message)) { + return false; + } + + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + + /** + * Converts a PEAR_LOG_* constant into a syslog LOG_* constant. + * + * This function exists because, under Windows, not all of the LOG_* + * constants have unique values. Instead, the PEAR_LOG_* were introduced + * for global use, with the conversion to the LOG_* constants kept local to + * to the syslog driver. + * + * @param int $priority PEAR_LOG_* value to convert to LOG_* value. + * + * @return The LOG_* representation of $priority. + * + * @access private + */ + function _toSyslog($priority) + { + static $priorities = array( + PEAR_LOG_EMERG => LOG_EMERG, + PEAR_LOG_ALERT => LOG_ALERT, + PEAR_LOG_CRIT => LOG_CRIT, + PEAR_LOG_ERR => LOG_ERR, + PEAR_LOG_WARNING => LOG_WARNING, + PEAR_LOG_NOTICE => LOG_NOTICE, + PEAR_LOG_INFO => LOG_INFO, + PEAR_LOG_DEBUG => LOG_DEBUG + ); + + /* If we're passed an unknown priority, default to LOG_INFO. */ + if (!is_int($priority) || !in_array($priority, $priorities)) { + return LOG_INFO; + } + + return $priorities[$priority]; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log/win.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log/win.php --- php-log-1.9.11/Log-1.9.16/Log/win.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log/win.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,269 @@ + + * @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 styles. + * @var array + * @access private + */ + var $_styles = array( + PEAR_LOG_EMERG => 'color: red;', + PEAR_LOG_ALERT => 'color: orange;', + PEAR_LOG_CRIT => 'color: yellow;', + PEAR_LOG_ERR => 'color: green;', + PEAR_LOG_WARNING => 'color: blue;', + PEAR_LOG_NOTICE => 'color: indigo;', + PEAR_LOG_INFO => 'color: violet;', + PEAR_LOG_DEBUG => 'color: 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['styles']) && is_array($conf['styles'])) { + $this->_styles = $conf['styles']; + } + if (isset($conf['colors']) && is_array($conf['colors'])) { + foreach ($conf['colors'] as $level => $color) { + $this->_styles[$level] .= "color: $color;"; + } + } + + 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; + $styles = $this->_styles; + + if (!empty($this->_ident)) { + $identHeader = "$win.document.writeln('Ident')"; + } else { + $identHeader = ''; + } + + echo <<< EOT + +EOT; + $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); + $message = preg_replace('/\r\n|\n|\r/', '
', $message); + + list($usec, $sec) = explode(' ', microtime()); + + /* Build the output line that contains the log entry row. */ + $line = ''; + $line .= sprintf('%s.%s', + strftime('%H:%M:%S', $sec), substr($usec, 2, 2)); + if (!empty($this->_ident)) { + $line .= '' . $this->_ident . ''; + } + $line .= '' . ucfirst($this->priorityToString($priority)) . ''; + $line .= sprintf('%s', $priority, $message); + $line .= ''; + + $this->_writeln($line); + + $this->_announce(array('priority' => $priority, 'message' => $message)); + + return true; + } + +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/Log.php /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/Log.php --- php-log-1.9.11/Log-1.9.16/Log.php 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/Log.php 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,847 @@ + + * @author Jon Parise + * @since Horde 1.3 + * @package Log + */ +class Log +{ + /** + * Indicates whether or not the log can been opened / connected. + * + * @var boolean + * @access protected + */ + var $_opened = false; + + /** + * Instance-specific unique identification number. + * + * @var integer + * @access protected + */ + var $_id = 0; + + /** + * The label that uniquely identifies this set of log messages. + * + * @var string + * @access protected + */ + var $_ident = ''; + + /** + * The default priority to use when logging an event. + * + * @var integer + * @access protected + */ + var $_priority = PEAR_LOG_INFO; + + /** + * The bitmask of allowed log levels. + * + * @var integer + * @access protected + */ + var $_mask = PEAR_LOG_ALL; + + /** + * Holds all Log_observer objects that wish to be notified of new messages. + * + * @var array + * @access protected + */ + var $_listeners = array(); + + /** + * Maps canonical format keys to position arguments for use in building + * "line format" strings. + * + * @var array + * @access protected + */ + var $_formatMap = array('%{timestamp}' => '%1$s', + '%{ident}' => '%2$s', + '%{priority}' => '%3$s', + '%{message}' => '%4$s', + '%{file}' => '%5$s', + '%{line}' => '%6$s', + '%{function}' => '%7$s', + '%\{' => '%%{'); + + /** + * Utility function which wraps PHP's class_exists() function to ensure + * consistent behavior between PHP versions 4 and 5. Autoloading behavior + * is always disabled. + * + * @param string $class The name of the class whose existence should + * be tested. + * + * @return bool True if the class exists. + * + * @access private + * @since Log 1.9.13 + */ + function _classExists($class) + { + if (version_compare(PHP_VERSION, '5.0.0', 'ge')) { + return class_exists($class, false); + } + + return class_exists($class); + } + + /** + * Attempts to return a concrete Log instance of type $handler. + * + * @param string $handler The type of concrete Log subclass to return. + * Attempt to dynamically include the code for + * this subclass. Currently, valid values are + * 'console', 'syslog', 'sql', 'file', and 'mcal'. + * + * @param string $name The name of the actually log file, table, or + * other specific store to use. Defaults to an + * empty string, with which the subclass will + * attempt to do something intelligent. + * + * @param string $ident The identity reported to the log system. + * + * @param array $conf A hash containing any additional configuration + * information that a subclass might need. + * + * @param int $level Log messages up to and including this level. + * + * @return object Log The newly created concrete Log instance, or + * null on an error. + * @access public + * @since Log 1.0 + */ + function &factory($handler, $name = '', $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + $handler = strtolower($handler); + $class = 'Log_' . $handler; + $classfile = 'Log/' . $handler . '.php'; + + /* + * Attempt to include our version of the named class, but don't treat + * a failure as fatal. The caller may have already included their own + * version of the named class. + */ + if (!Log::_classExists($class)) { + include_once $classfile; + } + + /* If the class exists, return a new instance of it. */ + if (Log::_classExists($class)) { + $obj = &new $class($name, $ident, $conf, $level); + return $obj; + } + + $null = null; + return $null; + } + + /** + * Attempts to return a reference to a concrete Log instance of type + * $handler, only creating a new instance if no log instance with the same + * parameters currently exists. + * + * You should use this if there are multiple places you might create a + * logger, you don't want to create multiple loggers, and you don't want to + * check for the existance of one each time. The singleton pattern does all + * the checking work for you. + * + * You MUST call this method with the $var = &Log::singleton() syntax. + * Without the ampersand (&) in front of the method name, you will not get + * a reference, you will get a copy. + * + * @param string $handler The type of concrete Log subclass to return. + * Attempt to dynamically include the code for + * this subclass. Currently, valid values are + * 'console', 'syslog', 'sql', 'file', and 'mcal'. + * + * @param string $name The name of the actually log file, table, or + * other specific store to use. Defaults to an + * empty string, with which the subclass will + * attempt to do something intelligent. + * + * @param string $ident The identity reported to the log system. + * + * @param array $conf A hash containing any additional configuration + * information that a subclass might need. + * + * @param int $level Log messages up to and including this level. + * + * @return object Log The newly created concrete Log instance, or + * null on an error. + * @access public + * @since Log 1.0 + */ + function &singleton($handler, $name = '', $ident = '', $conf = array(), + $level = PEAR_LOG_DEBUG) + { + static $instances; + if (!isset($instances)) $instances = array(); + + $signature = serialize(array($handler, $name, $ident, $conf, $level)); + if (!isset($instances[$signature])) { + $instances[$signature] = &Log::factory($handler, $name, $ident, + $conf, $level); + } + + return $instances[$signature]; + } + + /** + * Abstract implementation of the open() method. + * @since Log 1.0 + */ + function open() + { + return false; + } + + /** + * Abstract implementation of the close() method. + * @since Log 1.0 + */ + function close() + { + return false; + } + + /** + * Abstract implementation of the flush() method. + * @since Log 1.8.2 + */ + function flush() + { + return false; + } + + /** + * Abstract implementation of the log() method. + * @since Log 1.0 + */ + function log($message, $priority = null) + { + return false; + } + + /** + * A convenience function for logging a emergency event. It will log a + * message at the PEAR_LOG_EMERG log level. + * + * @param mixed $message String or object containing the message + * to log. + * + * @return boolean True if the message was successfully logged. + * + * @access public + * @since Log 1.7.0 + */ + function emerg($message) + { + return $this->log($message, PEAR_LOG_EMERG); + } + + /** + * A convenience function for logging an alert event. It will log a + * message at the PEAR_LOG_ALERT log level. + * + * @param mixed $message String or object containing the message + * to log. + * + * @return boolean True if the message was successfully logged. + * + * @access public + * @since Log 1.7.0 + */ + function alert($message) + { + return $this->log($message, PEAR_LOG_ALERT); + } + + /** + * A convenience function for logging a critical event. It will log a + * message at the PEAR_LOG_CRIT log level. + * + * @param mixed $message String or object containing the message + * to log. + * + * @return boolean True if the message was successfully logged. + * + * @access public + * @since Log 1.7.0 + */ + function crit($message) + { + return $this->log($message, PEAR_LOG_CRIT); + } + + /** + * A convenience function for logging a error event. It will log a + * message at the PEAR_LOG_ERR log level. + * + * @param mixed $message String or object containing the message + * to log. + * + * @return boolean True if the message was successfully logged. + * + * @access public + * @since Log 1.7.0 + */ + function err($message) + { + return $this->log($message, PEAR_LOG_ERR); + } + + /** + * A convenience function for logging a warning event. It will log a + * message at the PEAR_LOG_WARNING log level. + * + * @param mixed $message String or object containing the message + * to log. + * + * @return boolean True if the message was successfully logged. + * + * @access public + * @since Log 1.7.0 + */ + function warning($message) + { + return $this->log($message, PEAR_LOG_WARNING); + } + + /** + * A convenience function for logging a notice event. It will log a + * message at the PEAR_LOG_NOTICE log level. + * + * @param mixed $message String or object containing the message + * to log. + * + * @return boolean True if the message was successfully logged. + * + * @access public + * @since Log 1.7.0 + */ + function notice($message) + { + return $this->log($message, PEAR_LOG_NOTICE); + } + + /** + * A convenience function for logging a information event. It will log a + * message at the PEAR_LOG_INFO log level. + * + * @param mixed $message String or object containing the message + * to log. + * + * @return boolean True if the message was successfully logged. + * + * @access public + * @since Log 1.7.0 + */ + function info($message) + { + return $this->log($message, PEAR_LOG_INFO); + } + + /** + * A convenience function for logging a debug event. It will log a + * message at the PEAR_LOG_DEBUG log level. + * + * @param mixed $message String or object containing the message + * to log. + * + * @return boolean True if the message was successfully logged. + * + * @access public + * @since Log 1.7.0 + */ + function debug($message) + { + return $this->log($message, PEAR_LOG_DEBUG); + } + + /** + * Returns the string representation of the message data. + * + * If $message is an object, _extractMessage() will attempt to extract + * the message text using a known method (such as a PEAR_Error object's + * getMessage() method). If a known method, cannot be found, the + * serialized representation of the object will be returned. + * + * If the message data is already a string, it will be returned unchanged. + * + * @param mixed $message The original message data. This may be a + * string or any object. + * + * @return string The string representation of the message. + * + * @access protected + */ + function _extractMessage($message) + { + /* + * If we've been given an object, attempt to extract the message using + * a known method. If we can't find such a method, default to the + * "human-readable" version of the object. + * + * We also use the human-readable format for arrays. + */ + if (is_object($message)) { + if (method_exists($message, 'getmessage')) { + $message = $message->getMessage(); + } else if (method_exists($message, 'tostring')) { + $message = $message->toString(); + } else if (method_exists($message, '__tostring')) { + if (version_compare(PHP_VERSION, '5.0.0', 'ge')) { + $message = (string)$message; + } else { + $message = $message->__toString(); + } + } else { + $message = print_r($message, true); + } + } else if (is_array($message)) { + if (isset($message['message'])) { + $message = $message['message']; + } else { + $message = print_r($message, true); + } + } + + /* Otherwise, we assume the message is a string. */ + return $message; + } + + /** + * Using debug_backtrace(), returns the file, line, and enclosing function + * name of the source code context from which log() was invoked. + * + * @param int $depth The initial number of frames we should step + * back into the trace. + * + * @return array Array containing three strings: the filename, the line, + * and the function name from which log() was called. + * + * @access private + * @since Log 1.9.4 + */ + function _getBacktraceVars($depth) + { + /* Start by generating a backtrace from the current call (here). */ + $backtrace = debug_backtrace(); + + /* + * If we were ultimately invoked by the composite handler, we need to + * increase our depth one additional level to compensate. + */ + if (strcasecmp(@$backtrace[$depth+1]['class'], 'Log_composite') == 0) { + $depth++; + } + + /* + * We're interested in the frame which invoked the log() function, so + * we need to walk back some number of frames into the backtrace. The + * $depth parameter tells us where to start looking. We go one step + * further back to find the name of the encapsulating function from + * which log() was called. + */ + $file = @$backtrace[$depth]['file']; + $line = @$backtrace[$depth]['line']; + $func = @$backtrace[$depth + 1]['function']; + + /* + * However, if log() was called from one of our "shortcut" functions, + * we're going to need to go back an additional step. + */ + if (in_array($func, array('emerg', 'alert', 'crit', 'err', 'warning', + 'notice', 'info', 'debug'))) { + $file = @$backtrace[$depth + 1]['file']; + $line = @$backtrace[$depth + 1]['line']; + $func = @$backtrace[$depth + 2]['function']; + } + + /* + * If we couldn't extract a function name (perhaps because we were + * executed from the "main" context), provide a default value. + */ + if (is_null($func)) { + $func = '(none)'; + } + + /* Return a 3-tuple containing (file, line, function). */ + return array($file, $line, $func); + } + + /** + * Produces a formatted log line based on a format string and a set of + * variables representing the current log record and state. + * + * @return string Formatted log string. + * + * @access protected + * @since Log 1.9.4 + */ + function _format($format, $timestamp, $priority, $message) + { + /* + * If the format string references any of the backtrace-driven + * variables (%5, %6, %7), generate the backtrace and fetch them. + */ + if (strpos($format, '%5') || strpos($format, '%6') || strpos($format, '%7')) { + list($file, $line, $func) = $this->_getBacktraceVars(2); + } + + /* + * Build the formatted string. We use the sprintf() function's + * "argument swapping" capability to dynamically select and position + * the variables which will ultimately appear in the log string. + */ + return sprintf($format, + $timestamp, + $this->_ident, + $this->priorityToString($priority), + $message, + isset($file) ? $file : '', + isset($line) ? $line : '', + isset($func) ? $func : ''); + } + + /** + * Returns the string representation of a PEAR_LOG_* integer constant. + * + * @param int $priority A PEAR_LOG_* integer constant. + * + * @return string The string representation of $level. + * + * @access public + * @since Log 1.0 + */ + function priorityToString($priority) + { + $levels = array( + PEAR_LOG_EMERG => 'emergency', + PEAR_LOG_ALERT => 'alert', + PEAR_LOG_CRIT => 'critical', + PEAR_LOG_ERR => 'error', + PEAR_LOG_WARNING => 'warning', + PEAR_LOG_NOTICE => 'notice', + PEAR_LOG_INFO => 'info', + PEAR_LOG_DEBUG => 'debug' + ); + + return $levels[$priority]; + } + + /** + * Returns the the PEAR_LOG_* integer constant for the given string + * representation of a priority name. This function performs a + * case-insensitive search. + * + * @param string $name String containing a priority name. + * + * @return string The PEAR_LOG_* integer contstant corresponding + * the the specified priority name. + * + * @access public + * @since Log 1.9.0 + */ + function stringToPriority($name) + { + $levels = array( + 'emergency' => PEAR_LOG_EMERG, + 'alert' => PEAR_LOG_ALERT, + 'critical' => PEAR_LOG_CRIT, + 'error' => PEAR_LOG_ERR, + 'warning' => PEAR_LOG_WARNING, + 'notice' => PEAR_LOG_NOTICE, + 'info' => PEAR_LOG_INFO, + 'debug' => PEAR_LOG_DEBUG + ); + + return $levels[strtolower($name)]; + } + + /** + * Calculate the log mask for the given priority. + * + * This method may be called statically. + * + * @param integer $priority The priority whose mask will be calculated. + * + * @return integer The calculated log mask. + * + * @access public + * @since Log 1.7.0 + */ + function MASK($priority) + { + return (1 << $priority); + } + + /** + * Calculate the log mask for all priorities up to the given priority. + * + * This method may be called statically. + * + * @param integer $priority The maximum priority covered by this mask. + * + * @return integer The resulting log mask. + * + * @access public + * @since Log 1.7.0 + * + * @deprecated deprecated since Log 1.9.4; use Log::MAX() instead + */ + function UPTO($priority) + { + return Log::MAX($priority); + } + + /** + * Calculate the log mask for all priorities greater than or equal to the + * given priority. In other words, $priority will be the lowest priority + * matched by the resulting mask. + * + * This method may be called statically. + * + * @param integer $priority The minimum priority covered by this mask. + * + * @return integer The resulting log mask. + * + * @access public + * @since Log 1.9.4 + */ + function MIN($priority) + { + return PEAR_LOG_ALL ^ ((1 << $priority) - 1); + } + + /** + * Calculate the log mask for all priorities less than or equal to the + * given priority. In other words, $priority will be the highests priority + * matched by the resulting mask. + * + * This method may be called statically. + * + * @param integer $priority The maximum priority covered by this mask. + * + * @return integer The resulting log mask. + * + * @access public + * @since Log 1.9.4 + */ + function MAX($priority) + { + return ((1 << ($priority + 1)) - 1); + } + + /** + * Set and return the level mask for the current Log instance. + * + * @param integer $mask A bitwise mask of log levels. + * + * @return integer The current level mask. + * + * @access public + * @since Log 1.7.0 + */ + function setMask($mask) + { + $this->_mask = $mask; + + return $this->_mask; + } + + /** + * Returns the current level mask. + * + * @return interger The current level mask. + * + * @access public + * @since Log 1.7.0 + */ + function getMask() + { + return $this->_mask; + } + + /** + * Check if the given priority is included in the current level mask. + * + * @param integer $priority The priority to check. + * + * @return boolean True if the given priority is included in the current + * log mask. + * + * @access protected + * @since Log 1.7.0 + */ + function _isMasked($priority) + { + return (Log::MASK($priority) & $this->_mask); + } + + /** + * Returns the current default priority. + * + * @return integer The current default priority. + * + * @access public + * @since Log 1.8.4 + */ + function getPriority() + { + return $this->_priority; + } + + /** + * Sets the default priority to the specified value. + * + * @param integer $priority The new default priority. + * + * @access public + * @since Log 1.8.4 + */ + function setPriority($priority) + { + $this->_priority = $priority; + } + + /** + * Adds a Log_observer instance to the list of observers that are listening + * for messages emitted by this Log instance. + * + * @param object $observer The Log_observer instance to attach as a + * listener. + * + * @param boolean True if the observer is successfully attached. + * + * @access public + * @since Log 1.0 + */ + function attach(&$observer) + { + if (!is_a($observer, 'Log_observer')) { + return false; + } + + $this->_listeners[$observer->_id] = &$observer; + + return true; + } + + /** + * Removes a Log_observer instance from the list of observers. + * + * @param object $observer The Log_observer instance to detach from + * the list of listeners. + * + * @param boolean True if the observer is successfully detached. + * + * @access public + * @since Log 1.0 + */ + function detach($observer) + { + if (!is_a($observer, 'Log_observer') || + !isset($this->_listeners[$observer->_id])) { + return false; + } + + unset($this->_listeners[$observer->_id]); + + return true; + } + + /** + * Informs each registered observer instance that a new message has been + * logged. + * + * @param array $event A hash describing the log event. + * + * @access protected + */ + function _announce($event) + { + foreach ($this->_listeners as $id => $listener) { + if ($event['priority'] <= $this->_listeners[$id]->_priority) { + $this->_listeners[$id]->notify($event); + } + } + } + + /** + * Indicates whether this is a composite class. + * + * @return boolean True if this is a composite class. + * + * @access public + * @since Log 1.0 + */ + function isComposite() + { + return false; + } + + /** + * Sets this Log instance's identification string. + * + * @param string $ident The new identification string. + * + * @access public + * @since Log 1.6.3 + */ + function setIdent($ident) + { + $this->_ident = $ident; + } + + /** + * Returns the current identification string. + * + * @return string The current Log instance's identification string. + * + * @access public + * @since Log 1.6.3 + */ + function getIdent() + { + return $this->_ident; + } +} diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/misc/log.sql /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/misc/log.sql --- php-log-1.9.11/Log-1.9.16/misc/log.sql 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/misc/log.sql 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,10 @@ +-- $Id: log.sql,v 1.1 2006/06/26 15:25:35 jon Exp $ + +CREATE TABLE log_table ( + id INT NOT NULL, + logtime TIMESTAMP NOT NULL, + ident CHAR(16) NOT NULL, + priority INT NOT NULL, + message VARCHAR(200), + PRIMARY KEY (id) +); diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/composite.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/composite.phpt --- php-log-1.9.11/Log-1.9.16/tests/composite.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/composite.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,28 @@ +--TEST-- +Log: Composite Handler +--FILE-- + '%2$s [%3$s] %4$s'); +$console1 = &Log::singleton('console', '', 'CONSOLE1', $conf); +$console2 = &Log::singleton('console', '', 'CONSOLE2', $conf); + +$composite = &Log::singleton('composite'); +$composite->addChild($console1); +$composite->addChild($console2); + +$composite->log('This event will be logged to both handlers.'); + +$composite->setIdent('IDENT'); +echo $composite->getIdent() . "\n"; + +$composite->log('This event will be logged to both handlers.'); + +--EXPECT-- +CONSOLE1 [info] This event will be logged to both handlers. +CONSOLE2 [info] This event will be logged to both handlers. +IDENT +IDENT [info] This event will be logged to both handlers. +IDENT [info] This event will be logged to both handlers. diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/console.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/console.phpt --- php-log-1.9.11/Log-1.9.16/tests/console.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/console.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,43 @@ +--TEST-- +Log: Console Handler +--FILE-- + '%2$s [%3$s] %4$s'); +$logger = &Log::singleton('console', '', 'ident', $conf); +for ($i = 0; $i < 3; $i++) { + $logger->log("Log entry $i"); +} + +echo "\n[Buffering / Flush Test]\n"; +$conf = array('lineFormat' => '%2$s [%3$s] %4$s', 'buffering' => true); +$buffered_logger = &Log::singleton('console', '', 'buffered', $conf); +for ($i = 0; $i < 3; $i++) { + $buffered_logger->log("Pre-flush buffered log entry $i"); +} +echo "Pre-flush\n"; +$buffered_logger->flush(); +echo "Post-flush\n"; +for ($i = 0; $i < 3; $i++) { + $buffered_logger->log("Post-flush buffered log entry $i"); +} +echo "Shutdown\n"; +$buffered_logger->close(); + +--EXPECT-- +ident [info] Log entry 0 +ident [info] Log entry 1 +ident [info] Log entry 2 + +[Buffering / Flush Test] +Pre-flush +buffered [info] Pre-flush buffered log entry 0 +buffered [info] Pre-flush buffered log entry 1 +buffered [info] Pre-flush buffered log entry 2 +Post-flush +Shutdown +buffered [info] Post-flush buffered log entry 0 +buffered [info] Post-flush buffered log entry 1 +buffered [info] Post-flush buffered log entry 2 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/display.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/display.phpt --- php-log-1.9.11/Log-1.9.16/tests/display.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/display.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,56 @@ +--TEST-- +Log: Display Handler +--FILE-- +log("Info", PEAR_LOG_INFO); + $logger->log("Error", PEAR_LOG_ERR); + $logger->log("Debug", PEAR_LOG_DEBUG); + $logger->log("Multi\nLine\nEntry", PEAR_LOG_INFO); + + echo "\n"; +} + +test('Default', array()); +test('Line Break', array('linebreak' => "\n")); +test('Format', array('lineFormat' => '')); +test('Prepend / Append', array('error_prepend' => '', + 'error_append' => '')); + +--EXPECT-- +Testing Default Configuration +------------------------------------------------------ +info: Infoerror: Errordebug: Debuginfo: Multi
+Line
+Entry + +Testing Line Break Configuration +------------------------------------------------------ +info: Info +error: Error +debug: Debug +info: Multi
+Line
+Entry + + +Testing Format Configuration +------------------------------------------------------ + + +Testing Prepend / Append Configuration +------------------------------------------------------ +info: Infoerror: Errordebug: Debuginfo: Multi
+Line
+Entry diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/error_log.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/error_log.phpt --- php-log-1.9.11/Log-1.9.16/tests/error_log.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/error_log.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,18 @@ +--TEST-- +Log: Error_Log Handler +--SKIPIF-- + +--FILE-- +log("Log entry $i"); +} + +--EXPECT-- +ident: Log entry 0 +ident: Log entry 1 +ident: Log entry 2 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/extract-zend1.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/extract-zend1.phpt --- php-log-1.9.11/Log-1.9.16/tests/extract-zend1.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/extract-zend1.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,54 @@ +--TEST-- +Log: _extractMessage() [Zend Engine 1.0] +--SKIPIF-- +=")) die('skip'); ?> +--FILE-- + '%2$s [%3$s] %4$s'); +$logger = &Log::singleton('console', '', 'ident', $conf); + +/* Logging a regular string. */ +$logger->log('String'); + +/* Logging a bare object. */ +class BareObject {} +$logger->log(new BareObject()); + +/* Logging an object with a getMessage() method. */ +class GetMessageObject { function getMessage() { return "getMessage"; } } +$logger->log(new GetMessageObject()); + +/* Logging an object with a toString() method. */ +class ToStringObject { function toString() { return "toString"; } } +$logger->log(new ToStringObject()); + +/* Logging a PEAR_Error object. */ +require_once 'PEAR.php'; +$logger->log(new PEAR_Error('PEAR_Error object', 100)); + +/* Logging an array. */ +$logger->log(array(1, 2, 'three' => 3)); + +/* Logging an array with a 'message' key. */ +$logger->log(array('message' => 'Message Key')); + +--EXPECT-- +ident [info] String +ident [info] bareobject Object +( +) + +ident [info] getMessage +ident [info] toString +ident [info] PEAR_Error object +ident [info] Array +( + [0] => 1 + [1] => 2 + [three] => 3 +) + +ident [info] Message Key diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/extract-zend2.0.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/extract-zend2.0.phpt --- php-log-1.9.11/Log-1.9.16/tests/extract-zend2.0.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/extract-zend2.0.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,62 @@ +--TEST-- +Log: _extractMessage() [Zend Engine 2.0] +--SKIPIF-- +=")) die('skip'); +?> +--FILE-- + '%2$s [%3$s] %4$s'); +$logger = &Log::singleton('console', '', 'ident', $conf); + +/* Logging a regular string. */ +$logger->log('String'); + +/* Logging a bare object. */ +class BareObject {} +$logger->log(new BareObject()); + +/* Logging an object with a getMessage() method. */ +class GetMessageObject { function getMessage() { return "getMessage"; } } +$logger->log(new GetMessageObject()); + +/* Logging an object with a toString() method. */ +class ToStringObject { function toString() { return "toString"; } } +$logger->log(new ToStringObject()); + +/* Logging an object with a __toString() method using casting. */ +class CastableObject { function __toString() { return "__toString"; } } +$logger->log(new CastableObject()); + +/* Logging a PEAR_Error object. */ +require_once 'PEAR.php'; +$logger->log(new PEAR_Error('PEAR_Error object', 100)); + +/* Logging an array. */ +$logger->log(array(1, 2, 'three' => 3)); + +/* Logging an array with a 'message' key. */ +$logger->log(array('message' => 'Message Key')); + +--EXPECT-- +ident [info] String +ident [info] BareObject Object +( +) + +ident [info] getMessage +ident [info] toString +ident [info] Object id #2 +ident [info] PEAR_Error object +ident [info] Array +( + [0] => 1 + [1] => 2 + [three] => 3 +) + +ident [info] Message Key diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/extract-zend2.2.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/extract-zend2.2.phpt --- php-log-1.9.11/Log-1.9.16/tests/extract-zend2.2.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/extract-zend2.2.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,59 @@ +--TEST-- +Log: _extractMessage() [Zend Engine 2.2] +--SKIPIF-- + +--FILE-- + '%2$s [%3$s] %4$s'); +$logger = &Log::singleton('console', '', 'ident', $conf); + +/* Logging a regular string. */ +$logger->log('String'); + +/* Logging a bare object. */ +class BareObject {} +$logger->log(new BareObject()); + +/* Logging an object with a getMessage() method. */ +class GetMessageObject { function getMessage() { return "getMessage"; } } +$logger->log(new GetMessageObject()); + +/* Logging an object with a toString() method. */ +class ToStringObject { function toString() { return "toString"; } } +$logger->log(new ToStringObject()); + +/* Logging an object with a __toString() method using casting. */ +class CastableObject { function __toString() { return "__toString"; } } +$logger->log(new CastableObject()); + +/* Logging a PEAR_Error object. */ +require_once 'PEAR.php'; +$logger->log(new PEAR_Error('PEAR_Error object', 100)); + +/* Logging an array. */ +$logger->log(array(1, 2, 'three' => 3)); + +/* Logging an array with a 'message' key. */ +$logger->log(array('message' => 'Message Key')); + +--EXPECT-- +ident [info] String +ident [info] BareObject Object +( +) + +ident [info] getMessage +ident [info] toString +ident [info] __toString +ident [info] PEAR_Error object +ident [info] Array +( + [0] => 1 + [1] => 2 + [three] => 3 +) + +ident [info] Message Key diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/factory.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/factory.phpt --- php-log-1.9.11/Log-1.9.16/tests/factory.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/factory.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,22 @@ +--TEST-- +Log: Factory +--FILE-- +_id != $console2->_id) { + echo "The objects have different IDs.\n"; +} + +--EXPECT-- +Two Log_console objects. +The objects have different IDs. diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/file.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/file.phpt --- php-log-1.9.11/Log-1.9.16/tests/file.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/file.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,29 @@ +--TEST-- +Log: File Handler +--FILE-- + '%2$s [%3$s] %4$s'); +$logger = &Log::singleton('file', $filename, '', $conf); + +for ($i = 0; $i < 3; $i++) { + $logger->log("Log entry $i"); +} +$logger->close(); + +/* Dump the contents of the log file. */ +echo file_get_contents($filename); + +/* Clean up. */ +if (file_exists($filename)) unlink($filename); + +--EXPECT-- + [info] Log entry 0 + [info] Log entry 1 + [info] Log entry 2 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/firebug.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/firebug.phpt --- php-log-1.9.11/Log-1.9.16/tests/firebug.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/firebug.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,96 @@ +--TEST-- +Log: Firebug Handler +--FILE-- +log('Debug', PEAR_LOG_DEBUG); +$logger->log('Info', PEAR_LOG_INFO); +$logger->log('Notice', PEAR_LOG_NOTICE); +$logger->log('Warning', PEAR_LOG_WARNING); +$logger->log('Error', PEAR_LOG_ERR); +$logger->log('Critical', PEAR_LOG_CRIT); +$logger->log('Alert', PEAR_LOG_ALERT); +$logger->log('Emergency', PEAR_LOG_EMERG); +unset($logger); + +print "\n** START BUFFERING **\n"; +$conf = array('buffering' => true); +$logger = &Log::singleton('firebug', '', 'PHP', $conf); +$logger->log('Debug', PEAR_LOG_DEBUG); +$logger->log('Info', PEAR_LOG_INFO); +$logger->log('Notice', PEAR_LOG_NOTICE); +$logger->log('Warning', PEAR_LOG_WARNING); +$logger->flush(); +print "** FLUSHED **\n"; +print "** REST OF BUFFERED **\n"; +$logger->log('Error', PEAR_LOG_ERR); +$logger->log('Critical', PEAR_LOG_CRIT); +$logger->log('Alert', PEAR_LOG_ALERT); +$logger->log('Emergency', PEAR_LOG_EMERG); +--EXPECT-- +** UNBUFFERED ** + + + + + + + + + +** START BUFFERING ** + +** FLUSHED ** +** REST OF BUFFERED ** + diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/levels.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/levels.phpt --- php-log-1.9.11/Log-1.9.16/tests/levels.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/levels.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,94 @@ +--TEST-- +Log: Levels +--FILE-- +log("Log entry $i"); +} + +--EXPECT-- diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/priority.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/priority.phpt --- php-log-1.9.11/Log-1.9.16/tests/priority.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/priority.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,30 @@ +--TEST-- +Log: Priorities +--FILE-- + '[%3$s] %4$s'); +$logger = &Log::singleton('console', '', 'ident', $conf); + +/* Log at the default PEAR_LOG_INFO level. */ +$logger->log('Log message'); + +/* Set the default priority to PEAR_LOG_DEBUG. */ +$logger->setPriority(PEAR_LOG_DEBUG); +$logger->log('Log message'); + +/* Verify that the getPriority() method also things we're at PEAR_LOG_DEBUG. */ +$priority = $logger->priorityToString($logger->getPriority()); +echo "$priority\n"; + +/* Verify that stringToPriority() can convert back to a constant. */ +$priority = $logger->stringToPriority($priority); +echo "$priority\n"; + +--EXPECT-- +[info] Log message +[debug] Log message +debug +7 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/singleton.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/singleton.phpt --- php-log-1.9.11/Log-1.9.16/tests/singleton.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/singleton.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,22 @@ +--TEST-- +Log: Singleton +--FILE-- +_id == $console2->_id) { + echo "The objects have the same ID.\n"; +} + +--EXPECT-- +Two Log_console objects. +The objects have the same ID. diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/sql_ident.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/sql_ident.phpt --- php-log-1.9.11/Log-1.9.16/tests/sql_ident.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/sql_ident.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,25 @@ +--TEST-- +Log: SQL setIdent() +--SKIPIF-- +packageExists('DB')) die("skip\n"); +--FILE-- + '')); +echo $logger->getIdent() . "\n"; + +$logger->setIdent($ident); +echo $logger->getIdent() . "\n"; + +--EXPECT-- +1234567890123456 +1234567890123456 diff -Nru /tmp/7scurou5oz/php-log-1.9.11/Log-1.9.16/tests/sqlite.phpt /tmp/SnCcFixfIb/php-log-1.9.16/Log-1.9.16/tests/sqlite.phpt --- php-log-1.9.11/Log-1.9.16/tests/sqlite.phpt 1970-01-01 01:00:00.000000000 +0100 +++ php-log-1.9.16/Log-1.9.16/tests/sqlite.phpt 2008-01-19 23:31:09.000000000 +0100 @@ -0,0 +1,29 @@ +--TEST-- +Log: Sqlite Handler +--SKIPIF-- + +--FILE-- +log($message, PEAR_LOG_WARNING); + +$q = "SELECT message FROM log_table WHERE ident='$ident'"; +$res = sqlite_query($db, $q); +if (sqlite_fetch_string($res) == $message) { + echo 'ok'; +} + +sqlite_close($db); +if (file_exists($filename)) unlink($filename); + +--EXPECT-- +ok diff -Nru /tmp/7scurou5oz/php-log-1.9.11/package.xml /tmp/SnCcFixfIb/php-log-1.9.16/package.xml --- php-log-1.9.11/package.xml 2007-05-14 08:45:59.000000000 +0200 +++ php-log-1.9.16/package.xml 2008-01-19 23:31:10.000000000 +0100 @@ -1,9 +1,9 @@ - + Log pear.php.net - Logging utilities - The Log framework provides an abstracted logging system. It supports logging to console, file, syslog, SQL, Sqlite, mail, and mcal targets. It also provides a subject - observer mechanism. + Logging Framework + The Log package provides an abstracted logging framework. It includes output handlers for log files, databases, syslog, email, Firebug, and the console. It also provides composite and subject-observer logging mechanisms. Jon Parise jon @@ -22,10 +22,10 @@ jan@horde.org yes - 2007-05-13 - + 2008-01-19 + - 1.9.11 + 1.9.16 1.0.0 @@ -33,59 +33,62 @@ stable PHP License - A Firebug log handler has been added. + - Corrected some PHPDoc syntax problems. +- Correcting some spelling errors in the users guide. +- Fixed the firebug unit test. +- Simplified the PEAR_LOG_ALL and PEAR_LOG_NONE constants. - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + - - + + - + - + - + - - + + - + @@ -117,6 +120,77 @@ + 1.9.16 + 1.0.0 + + + stable + stable + + 2008-01-19 + PHP License + - Corrected some PHPDoc syntax problems. +- Correcting some spelling errors in the users guide. +- Fixed the firebug unit test. +- Simplified the PEAR_LOG_ALL and PEAR_LOG_NONE constants. + + + + 1.9.15 + 1.0.0 + + + stable + stable + + 2008-01-19 + PHP License + - The Firebug handler now avoids more Javascript errors in IE. (Bug 12810) + + + + 1.9.14 + 1.0.0 + + + stable + stable + + 2008-01-01 + PHP License + - The sql handler wasn't honoring custom SQL insertion statements. (Bug 12734) +- The display handler now has a configurable line format. (Request 12781) + + + + 1.9.13 + 1.0.0 + + + stable + stable + + 2007-12-12 + PHP License + - The Firebug handler's unit test now passes. (Bug 12674) +- Fixed a PHP4 compatibility problem involving class_exists(). (Bug 12675) + + + + 1.9.12 + 1.0.0 + + + stable + stable + + 2007-12-11 + PHP License + - The Firebug handler no longer generates Javascript errors in IE. (Bug 12607) +- The users guide has been updated with information on writing custom handlers. + + + 1.9.11 1.0.0