Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 482 lines (452 sloc) 12.489 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
<?php
/**
* Logging.
*
* Log messages to text files.
*
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package Cake.Log
* @since CakePHP(tm) v 0.2.9
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/

/**
* Set up error level constants to be used within the framework if they are not defined within the
* system.
*
*/
if (!defined('LOG_EMERG')) {
define('LOG_EMERG', 0);
}
if (!defined('LOG_ALERT')) {
define('LOG_ALERT', 1);
}
if (!defined('LOG_CRIT')) {
define('LOG_CRIT', 2);
}
if (!defined('LOG_ERR')) {
define('LOG_ERR', 3);
}
if (!defined('LOG_ERROR')) {
define('LOG_ERROR', LOG_ERR);
}
if (!defined('LOG_WARNING')) {
define('LOG_WARNING', 4);
}
if (!defined('LOG_NOTICE')) {
define('LOG_NOTICE', 5);
}
if (!defined('LOG_INFO')) {
define('LOG_INFO', 6);
}
if (!defined('LOG_DEBUG')) {
define('LOG_DEBUG', 7);
}

App::uses('LogEngineCollection', 'Log');

/**
* Logs messages to configured Log adapters. One or more adapters can be configured
* using CakeLogs's methods. If you don't configure any adapters, and write to the logs
* a default FileLog will be autoconfigured for you.
*
* ### Configuring Log adapters
*
* You can configure log adapters in your applications `bootstrap.php` file. A sample configuration
* would look like:
*
* `CakeLog::config('my_log', array('engine' => 'FileLog'));`
*
* See the documentation on CakeLog::config() for more detail.
*
* ### Writing to the log
*
* You write to the logs using CakeLog::write(). See its documentation for more information.
*
* @package Cake.Log
*/
class CakeLog {

/**
* LogEngineCollection class
*
* @var LogEngineCollection
*/
protected static $_Collection;

/**
* Default log levels as detailed in RFC 5424
* http://tools.ietf.org/html/rfc5424
*/
protected static $_defaultLevels = array(
LOG_EMERG => 'emergency',
LOG_ALERT => 'alert',
LOG_CRIT => 'critical',
LOG_ERR => 'error',
LOG_WARNING => 'warning',
LOG_NOTICE => 'notice',
LOG_INFO => 'info',
LOG_DEBUG => 'debug',
);

/**
* Active log levels for this instance.
*/
protected static $_levels;

/**
* Mapped log levels
*/
protected static $_levelMap;

/**
* initialize ObjectCollection
*
* @return void
*/
protected static function _init() {
self::$_levels = self::defaultLevels();
self::$_Collection = new LogEngineCollection();
}

/**
* Configure and add a new logging stream to CakeLog
* You can use add loggers from app/Log/Engine use app.loggername, or any plugin/Log/Engine using plugin.loggername.
*
* ### Usage:
*
* {{{
* CakeLog::config('second_file', array(
* 'engine' => 'FileLog',
* 'path' => '/var/logs/my_app/'
* ));
* }}}
*
* Will configure a FileLog instance to use the specified path. All options that are not `engine`
* are passed onto the logging adapter, and handled there. Any class can be configured as a logging
* adapter as long as it implements the methods in CakeLogInterface.
*
* @param string $key The keyname for this logger, used to remove the logger later.
* @param array $config Array of configuration information for the logger
* @return boolean success of configuration.
* @throws CakeLogException
*/
public static function config($key, $config) {
if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $key)) {
throw new CakeLogException(__d('cake_dev', 'Invalid key name'));
}
if (empty($config['engine'])) {
throw new CakeLogException(__d('cake_dev', 'Missing logger classname'));
}
if (empty(self::$_Collection)) {
self::_init();
}
self::$_Collection->load($key, $config);
return true;
}

/**
* Returns the keynames of the currently active streams
*
* @return array Array of configured log streams.
*/
public static function configured() {
if (empty(self::$_Collection)) {
self::_init();
}
return self::$_Collection->attached();
}

/**
* Gets/sets log levels
*
* Call this method without arguments, eg: `CakeLog::levels()` to obtain current
* level configuration.
*
* To append additional level 'user0' and 'user1' to to default log levels:
*
* `CakeLog::levels(array('user0, 'user1'))` or
* `CakeLog::levels(array('user0, 'user1'), true)`
*
* will result in:
*
* array(
* 0 => 'emergency',
* 1 => 'alert',
* ...
* 8 => 'user0',
* 9 => 'user1',
* );
*
* To set/replace existing configuration, pass an array with the second argument
* set to false.
*
* `CakeLog::levels(array('user0, 'user1'), false);
*
* will result in:
* array(
* 0 => 'user0',
* 1 => 'user1',
* );
*
* @param mixed $levels array
* @param bool $append true to append, false to replace
* @return array active log levels
*/
public static function levels($levels = array(), $append = true) {
if (empty(self::$_Collection)) {
self::_init();
}
if (empty($levels)) {
return self::$_levels;
}
$levels = array_values($levels);
if ($append) {
self::$_levels = array_merge(self::$_levels, $levels);
} else {
self::$_levels = $levels;
}
self::$_levelMap = array_flip(self::$_levels);
return self::$_levels;
}

/**
* Reset log levels to the original value
*
* @return array default log levels
*/
public static function defaultLevels() {
self::$_levels = self::$_defaultLevels;
self::$_levelMap = array_flip(self::$_levels);
return self::$_levels;
}

/**
* Removes a stream from the active streams. Once a stream has been removed
* it will no longer have messages sent to it.
*
* @param string $streamName Key name of a configured stream to remove.
* @return void
*/
public static function drop($streamName) {
if (empty(self::$_Collection)) {
self::_init();
}
self::$_Collection->unload($streamName);
}

/**
* Checks wether $streamName is enabled
*
* @param string $streamName to check
* @return bool
* @throws CakeLogException
*/
public static function enabled($streamName) {
if (empty(self::$_Collection)) {
self::_init();
}
if (!isset(self::$_Collection->{$streamName})) {
throw new CakeLogException(__d('cake_dev', 'Stream %s not found', $streamName));
}
return self::$_Collection->enabled($streamName);
}

/**
* Enable stream
*
* @param string $streamName to enable
* @return void
* @throws CakeLogException
*/
public static function enable($streamName) {
if (empty(self::$_Collection)) {
self::_init();
}
if (!isset(self::$_Collection->{$streamName})) {
throw new CakeLogException(__d('cake_dev', 'Stream %s not found', $streamName));
}
self::$_Collection->enable($streamName);
}

/**
* Disable stream
*
* @param string $streamName to disable
* @return void
* @throws CakeLogException
*/
public static function disable($streamName) {
if (empty(self::$_Collection)) {
self::_init();
}
if (!isset(self::$_Collection->{$streamName})) {
throw new CakeLogException(__d('cake_dev', 'Stream %s not found', $streamName));
}
self::$_Collection->disable($streamName);
}

/**
* Gets the logging engine from the active streams.
*
* @see BaseLog
* @param string $streamName Key name of a configured stream to get.
* @return $mixed instance of BaseLog or false if not found
*/
public static function stream($streamName) {
if (empty(self::$_Collection)) {
self::_init();
}
if (!empty(self::$_Collection->{$streamName})) {
return self::$_Collection->{$streamName};
}
return false;
}

/**
* Configures the automatic/default stream a FileLog.
*
* @return void
*/
protected static function _autoConfig() {
self::$_Collection->load('error', array(
'engine' => 'FileLog',
'types' => array('warning', 'error', 'critical', 'alert', 'emergency'),
'path' => LOGS,
));
}

/**
* Writes the given message and type to all of the configured log adapters.
* Configured adapters are passed both the $type and $message variables. $type
* is one of the following strings/values.
*
* ### Types:
*
* - LOG_EMERG => 'emergency',
* - LOG_ALERT => 'alert',
* - LOG_CRIT => 'critical',
* - `LOG_ERR` => 'error',
* - `LOG_WARNING` => 'warning',
* - `LOG_NOTICE` => 'notice',
* - `LOG_INFO` => 'info',
* - `LOG_DEBUG` => 'debug',
*
* ### Usage:
*
* Write a message to the 'warning' log:
*
* `CakeLog::write('warning', 'Stuff is broken here');`
*
* @param mixed $type Type of message being written. When value is an integer
* or a string matching the recognized levels, then it will
* be treated log levels. Otherwise it's treated as scope.
* @param string $message Message content to log
* @param mixed $scope string or array
* @return boolean Success
*/
public static function write($type, $message, $scope = array()) {
if (empty(self::$_Collection)) {
self::_init();
}

if (is_int($type) && isset(self::$_levels[$type])) {
$type = self::$_levels[$type];
}
if (is_string($type) && empty($scope) && !in_array($type, self::$_levels)) {
$scope = $type;
}
if (!self::$_Collection->attached()) {
self::_autoConfig();
}
foreach (self::$_Collection->enabled() as $streamName) {
$logger = self::$_Collection->{$streamName};
$types = null;
$scopes = array();
if ($logger instanceof BaseLog) {
$config = $logger->config();
$types = $config['types'];
$scopes = $config['scopes'];
}
if (is_string($scope)) {
$inScope = in_array($scope, $scopes);
} else {
$intersect = array_intersect($scope, $scopes);
$inScope = !empty($intersect);
}
if (empty($types) || in_array($type, $types) || in_array($type, $scopes) && $inScope) {
$logger->write($type, $message);
}
}
return true;
}

/**
* Convenience method to log emergency messages
*
* @param string $message log message
* @param mixed $scope string or array of scopes
* @return boolean Success
*/
public static function emergency($message, $scope = array()) {
return self::write(self::$_levelMap['emergency'], $message, $scope);
}

/**
* Convenience method to log alert messages
*
* @param string $message log message
* @param mixed $scope string or array of scopes
* @return boolean Success
*/
public static function alert($message, $scope = array()) {
return self::write(self::$_levelMap['alert'], $message, $scope);
}

/**
* Convenience method to log critical messages
*
* @param string $message log message
* @param mixed $scope string or array of scopes
* @return boolean Success
*/
public static function critical($message, $scope = array()) {
return self::write(self::$_levelMap['critical'], $message, $scope);
}

/**
* Convenience method to log error messages
*
* @param string $message log message
* @param mixed $scope string or array of scopes
* @return boolean Success
*/
public static function error($message, $scope = array()) {
return self::write(self::$_levelMap['error'], $message, $scope);
}

/**
* Convenience method to log warning messages
*
* @param string $message log message
* @param mixed $scope string or array of scopes
* @return boolean Success
*/
public static function warning($message, $scope = array()) {
return self::write(self::$_levelMap['warning'], $message, $scope);
}

/**
* Convenience method to log notice messages
*
* @param string $message log message
* @param mixed $scope string or array of scopes
* @return boolean Success
*/
public static function notice($message, $scope = array()) {
return self::write(self::$_levelMap['notice'], $message, $scope);
}

/**
* Convenience method to log debug messages
*
* @param string $message log message
* @param mixed $scope string or array of scopes
* @return boolean Success
*/
public static function debug($message, $scope = array()) {
return self::write(self::$_levelMap['debug'], $message, $scope);
}

/**
* Convenience method to log info messages
*
* @param string $message log message
* @param mixed $scope string or array of scopes
* @return boolean Success
*/
public static function info($message, $scope = array()) {
return self::write(self::$_levelMap['info'], $message, $scope);
}

}
Something went wrong with that request. Please try again.