CodeIgniter框架源码学习之日志类－－Log.php

文件位置：./system/core/Log.php

<?php

/**

* CodeIgniter

*

* An open source application development framework for PHP

*

* This content is released under the MIT License (MIT)

*

* Copyright (c) 2014 - 2017, British Columbia Institute of Technology

*

* Permission is hereby granted, free of charge, to any person obtaining a copy

* of this software and associated documentation files (the "Software"), to deal

* in the Software without restriction, including without limitation the rights

* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

* copies of the Software, and to permit persons to whom the Software is

* furnished to do so, subject to the following conditions:

*

* The above copyright notice and this permission notice shall be included in

* all copies or substantial portions of the Software.

*

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

* THE SOFTWARE.

*

* @package CodeIgniter

* @author EllisLab Dev Team

* @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)

* @copyright Copyright (c) 2014 - 2017, British Columbia Institute of Technology (http://bcit.ca/)

* @license http://opensource.org/licenses/MIT MIT License

* @link https://codeigniter.com

* @since Version 1.0.0

* @filesource

*/

defined('BASEPATH') OR exit('No direct script access allowed');

/**

* Logging Class

*

* @package CodeIgniter

* @subpackage Libraries

* @category Logging

* @author EllisLab Dev Team

* @link https://codeigniter.com/user_guide/general/errors.html

*/

class CI_Log {

/**

* Path to save log files

* 保存日志文件的路径

* @var string

*/

protected $_log_path;

/**

* File permissions

* 文件权限

* @var int

*/

protected $_file_permissions = 0644;

/**

* Level of logging

* 打印级别

* @var int

*/

protected $_threshold = 1;

/**

* Array of threshold levels to log

* 打印的级别数组

* @var array

*/

protected $_threshold_array = array();

/**

* Format of timestamp for log files

* 日志文件的时间戳格式

* @var string

*/

protected $_date_fmt = 'Y-m-d H:i:s';

/**

* Filename extension

* 文件名扩展

* @var string

*/

protected $_file_ext;

/**

* Whether or not the logger can write to the log files

* 是否能写入日志文件

* @var bool

*/

protected $_enabled = TRUE;

/**

* Predefined logging levels

* 预定义打印等级

* @var array

*/

protected $_levels = array('ERROR' => 1, 'DEBUG' => 2, 'INFO' => 3, 'ALL' => 4);

/**

* mbstring.func_overload flag

*

* @var bool

*/

protected static $func_overload;

// --------------------------------------------------------------------

/**

* Class constructor

*

* @return void

*/

public function __construct()

{

$config =& get_config();

isset(self::$func_overload) OR self::$func_overload = (extension_loaded('mbstring') && ini_get('mbstring.func_overload'));

$this->_log_path = ($config['log_path'] !== '') ? $config['log_path'] : APPPATH.'logs/';

$this->_file_ext = (isset($config['log_file_extension']) && $config['log_file_extension'] !== '')

? ltrim($config['log_file_extension'], '.') : 'php';

file_exists($this->_log_path) OR mkdir($this->_log_path, 0755, TRUE);

if ( ! is_dir($this->_log_path) OR ! is_really_writable($this->_log_path))

{

$this->_enabled = FALSE;

}

if (is_numeric($config['log_threshold']))

{

$this->_threshold = (int) $config['log_threshold'];

}

elseif (is_array($config['log_threshold']))

{

$this->_threshold = 0;

$this->_threshold_array = array_flip($config['log_threshold']);

}

if ( ! empty($config['log_date_format']))

{

$this->_date_fmt = $config['log_date_format'];

}

if ( ! empty($config['log_file_permissions']) && is_int($config['log_file_permissions']))

{

$this->_file_permissions = $config['log_file_permissions'];

}

}

// --------------------------------------------------------------------

/**

* Write Log File

*

* Generally this function will be called using the global log_message() function

* 这个方法一般在全局函数log_message()里被使用

* @param string $level The error level: 'error', 'debug' or 'info'

* @param string $msg The error message

* @return bool

*/

public function write_log($level, $msg)

{

if ($this->_enabled === FALSE)

{

return FALSE;

}

$level = strtoupper($level);

if (( ! isset($this->_levels[$level]) OR ($this->_levels[$level] > $this->_threshold))

&& ! isset($this->_threshold_array[$this->_levels[$level]]))

{

return FALSE;

}

$filepath = $this->_log_path.'log-'.date('Y-m-d').'.'.$this->_file_ext;

$message = '';

if ( ! file_exists($filepath))

{

$newfile = TRUE;

// Only add protection to php files

if ($this->_file_ext === 'php')

{

$message .= "<?php defined('BASEPATH') OR exit('No direct script access allowed'); ?>\n\n";

}

}

if ( ! $fp = @fopen($filepath, 'ab'))

{

return FALSE;

}

flock($fp, LOCK_EX);

// Instantiating DateTime with microseconds appended to initial date is needed for proper support of this format

if (strpos($this->_date_fmt, 'u') !== FALSE)

{

$microtime_full = microtime(TRUE);

$microtime_short = sprintf("%06d", ($microtime_full - floor($microtime_full)) * 1000000);

$date = new DateTime(date('Y-m-d H:i:s.'.$microtime_short, $microtime_full));

$date = $date->format($this->_date_fmt);

}

else

{

$date = date($this->_date_fmt);

}

$message .= $this->_format_line($level, $date, $msg);

for ($written = 0, $length = self::strlen($message); $written < $length; $written += $result)

{

if (($result = fwrite($fp, self::substr($message, $written))) === FALSE)

{

break;

}

}

flock($fp, LOCK_UN);

fclose($fp);

if (isset($newfile) && $newfile === TRUE)

{

chmod($filepath, $this->_file_permissions);

}

return is_int($result);

}

// --------------------------------------------------------------------

/**

* Format the log line.

*

* This is for extensibility of log formatting

* If you want to change the log format, extend the CI_Log class and override this method

*

* @param string $level The error level

* @param string $date Formatted date string

* @param string $message The log message

* @return string Formatted log line with a new line character '\n' at the end

*/

protected function _format_line($level, $date, $message)

{

return $level.' - '.$date.' --> '.$message."\n";

}

// --------------------------------------------------------------------

/**

* Byte-safe strlen()

*

* @param string $str

* @return int

*/

protected static function strlen($str)

{

return (self::$func_overload)

? mb_strlen($str, '8bit')

: strlen($str);

}

// --------------------------------------------------------------------

/**

* Byte-safe substr()

*

* @param string $str

* @param int $start

* @param int $length

* @return string

*/

protected static function substr($str, $start, $length = NULL)

{

if (self::$func_overload)

{

// mb_substr($str, $start, null, '8bit') returns an empty

// string on PHP 5.3

isset($length) OR $length = ($start >= 0 ? self::strlen($str) - $start : -$start);

return mb_substr($str, $start, $length, '8bit');

}

return isset($length)

? substr($str, $start, $length)

: substr($str, $start);

}

}