WebStream\Log\Logger

Complexity

Total Complexity

52

Size/Duplication

Total Lines	376
Duplicated Lines	6.38 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	5
Bugs	0	Features	0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getConfig()	0	4	1
A	__destruct()	0	4	1
A	enableLazyWrite()	0	4	1
A	enableDirectWrite()	0	4	1
A	getInstance()	0	4	1
A	init()	0	6	1
A	finalize()	0	6	1
A	isInitialized()	0	4	1
A	__callStatic()	0	12	4
A	setOutputter()	0	9	3
A	getTimeStamp()	0	7	1
A	message()	0	14	3
C	write()	0	35	8
A	writeStatus()	0	4	1
A	readStatus()	0	12	2
A	createstatusPath()	0	7	2
A	rotate()	0	13	4
A	runRotate()	0	13	2
A	rotateByCycle()	12	12	2
A	rotateBySize()	12	12	2
A	getLogPath()	0	4	1
A	getLogRotateCycle()	0	4	1
A	getLogRotateSize()	0	4	1
A	lazyWrite()	0	8	3
A	directWrite()	0	8	3

<?php
namespace WebStream\Log;

use WebStream\Module\Utility\LoggerUtils;
use WebStream\Module\Container;
use WebStream\DI\ServiceLocator;
use WebStream\Exception\Extend\LoggerException;

/**
 * Loggerクラス
 * @author Ryuichi Tanaka
 * @since 2012/01/16
 * @version 0.7
 */
class Logger
{
    use LoggerUtils;

    /**
     * @var Logger ロガー
     */
    private static $logger;

    /**
     * @var LoggerFormatter ロガーフォーマッタ
     */
    private static $formatter;

    /**
     * @var Container ログ設定コンテナ
     */
    private static $config;

    /**
     * @var Container ログ設定コンテナ
     */
    private $logConfig;

    /**
     * @var array<IOoutputter> Outputterリスト
     */
    private $outputters;

    /**
     * コンストラクタ
     * @param Container ログ設定コンテナ
     */
    private function __construct(Container $logConfig)
    {
        $this->logConfig = $logConfig;
        $this->outputters = [];
    }

    /**
     * ログ設定を返却する
     * @return Container ログ設定
     */
    public function getConfig()
    {
        return $this->logConfig;
    }

    /**
     * デストラクタ
     */
    public function __destruct()
    {
        $this->directWrite();
    }

    /**
     * 遅延書き出しを有効にする
     */
    public static function enableLazyWrite()
    {
        self::$logger->lazyWrite();
    }

    /**
     * 即時書き出しを有効にする
     */
    public static function enableDirectWrite()
    {
        self::$logger->directWrite();
    }

    /**
     * インスタンスを返却する
     * @return WebStream\Module\Logger ロガーインスタンス
     */
    public static function getInstance()
    {
        return self::$logger;
    }

    /**
     * Loggerを初期化する
     * @param Container ログ設定コンテナ
     */
    public static function init(Container $config)
    {
        self::$config = $config;
        self::$logger = new Logger($config);
        self::$formatter = new LoggerFormatter($config);
    }

    /**
     * Loggerを終了する
     */
    public static function finalize()
    {
        self::$config = null;
        self::$logger = null;
        self::$formatter = null;
    }

    /**
     * Loggerが初期化済みかどうかチェックする
     * @param bool 初期化済みならtrue
     */
    public static function isInitialized()
    {
        return self::$logger !== null;
    }

    /**
     * Loggerメソッドの呼び出しを受ける
     * @param string メソッド名(ログレベル文字列)
     * @param array 引数
     */
    public static function __callStatic($level, $arguments)
    {
        if (self::$logger === null || self::$formatter === null) {
            if (self::$config !== null) {
                self::init(self::$config);
            } else {
                throw new LoggerException("Logger is not initialized.");
            }
        }

        call_user_func_array([self::$logger, "write"], array_merge([$level], $arguments));
    }

    /**
     * Outputterを設定する
     * @param array<IOutputter> $outputters Outputterリスト
     */
    public function setOutputter(array $outputters)
    {
        foreach ($outputters as $outputter) {
            if (!$outputter instanceof \WebStream\Log\Outputter\IOutputter) {
                throw new LoggerException("Log outputter must implement WebStream\Log\Outputter\IOutputter.");
            }
        }
        $this->outputters = $outputters;

It seems like $outputters of type array<integer,object<WebStream\Log\IOutputter>> is incompatible with the declared type array<integer,object<WebStream\Log\IOoutputter>> of property $outputters.

    }

    /**
     * タイムスタンプを取得する
     * @return string タイムスタンプ
     */
    private function getTimeStamp()

This method is not used, and could be removed.

    {
        date_default_timezone_set('Asia/Tokyo');
        $msec = sprintf("%2d", floatval(microtime()) * 100);

        return strftime("%Y-%m-%d %H:%M:%S") . "," . $msec;
    }

    /**
     * ログメッセージにスタックトレースの内容を追加する
     * @param string ログメッセージ
     * @param string スタックトレース文字列
     * @return string 加工済みログメッセージ
     */
    private function message($msg, $stacktrace = null)
    {
        // スタックトレースから原因となるエラー箇所のみ抽出
        $stacktraceList = explode("#", $stacktrace);
        foreach ($stacktraceList as $stacktraceLine) {
            if ($stacktraceLine === "") {
                continue;
            }
            $msg .= "\n";
            $msg .= "\t#" . trim($stacktraceLine);
        }

        return $msg;
    }

    /**
     * ログを書き出す
     * @param string ログレベル文字列
     * @param string 出力文字列
     * @param array<mixed> 埋め込み値リスト
     */
    public function write($level, $msg, $context = null)
    {
        if ($this->logConfig->logLevel > $this->toLogLevelValue($level)) {

The property logLevel does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            return;
        }

        if (is_array($context)) {
            // sprintfと同様の展開
            // [a-zA-Z0-9_-\.] 以外もキーには指定可能だが仕様としてこれ以外は不可とする
            preg_match_all('/\{\s*([a-zA-Z0-9._-]+)\s*?\}/', $msg, $matches);
            foreach ($matches[1] as $index => $value) {
                if (array_key_exists($value, $context)) {
                    $matches[1][$index] = $context[$value];
                } else {
                    unset($matches[0][$index]);
                }
            }
            $msg = str_replace($matches[0], $matches[1], $msg);
        } else {
            $msg = $this->message($msg, $context);
        }

        $this->rotate();
        try {
            if (count($this->outputters) > 0) {
                foreach ($this->outputters as $outputter) {
                    $outputter->write(self::$formatter->getFormattedMessage($msg, $level));
                }
            } else {
                error_log(self::$formatter->getFormattedMessage($msg, $level), 3, $this->logConfig->logPath);

The property logPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            }
        } catch (\Exception $e) {
            throw new LoggerException($e);
        }
    }

    /**
     * ログステータスファイルに書きこむ
     */
    private function writeStatus()
    {
        file_put_contents($this->logConfig->statusPath, intval(preg_replace('/^.*\s/', '', microtime())));

The property statusPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * ログステータスファイルを読み込む
     */
    private function readStatus()
    {
        $handle = fopen($this->logConfig->statusPath, "r");

The property statusPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

        $size = filesize($this->logConfig->statusPath);

The property statusPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

        $content = fread($handle, $size);
        fclose($handle);
        if (!preg_match('/^\d{10}$/', $content)) {
            throw new LoggerException("Invalid log state file contents: " . $content);
        }

        return intval($content);
    }

    /**
     * ステータスファイルを作成する
     */
    private function createstatusPath()
    {
        // ステータスファイルがない場合は書きだす
        if (!is_file($this->logConfig->statusPath)) {

The property statusPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->writeStatus();
        }
    }

    /**
     * ログファイルをアーカイブする
     * stream.log -> stream.(作成日時)-(現在日時).log
     * @param string ログファイルパス
     */
    private function rotate()
    {
        // ログファイルがない場合はローテートしない
        if (!realpath($this->logConfig->logPath)) {

The property logPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            return;
        }
        // ログローテート実行
        if ($this->logConfig->rotateCycle !== null) {

The property rotateCycle does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->rotateByCycle();
        } elseif ($this->logConfig->rotateSize !== null) {

The property rotateSize does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->rotateBySize();
        }
    }

    /**
     * ローテートを実行する
     * @param integer 作成日時のUnixTime
     * @param integer 現在日時のUnixTime
     */
    private function runRotate($from, $to)
    {
        $from_date = date("YmdHis", $from);
        $to_date = date("YmdHis", $to);
        $archive_path = null;

$archive_path is not used, you could remove the assignment.

        if (preg_match('/(.*)\.(.+)/', $this->logConfig->logPath, $matches)) {

The property logPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            $archive_path = "$matches[1].${from_date}-${to_date}.$matches[2]";
            // mvを実行
            rename($this->logConfig->logPath, $archive_path);

The property logPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            // ステータスファイルを削除
            unlink($this->logConfig->statusPath);

The property statusPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

        }
    }

    /**
     * 時間単位でローテートする
     * stream.log -> stream.(作成日時)-(現在日時).log
     */
    private function rotateByCycle()

This method seems to be duplicated in your project.

    {
        $this->createstatusPath();
        $now = intval(preg_replace('/^.*\s/', '', microtime()));
        $createdAt = $this->readStatus($this->logConfig->statusPath);

The property statusPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

The call to Logger::readStatus() has too many arguments starting with $this->logConfig->statusPath.

        // ローテート周期を過ぎている場合はログファイルをアーカイブする
        $hour = intval(floor(($now - $createdAt) / 3600));
        if ($hour >= $this->logConfig->rotateCycle) {

The property rotateCycle does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->runRotate($createdAt, $now);
        }
    }

    /**
     * サイズ単位でローテートする
     * stream.log -> stream.(作成日時)-(現在日時).log
     */
    private function rotateBySize()

This method seems to be duplicated in your project.

    {
        $this->createstatusPath();
        $now = intval(preg_replace('/^.*\s/', '', microtime()));
        $createdAt = $this->readStatus();

        $size_kb = (int) floor(filesize($this->logConfig->logPath) / 1024);

The property logPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

        // 指定したサイズより大きければローテート
        if ($size_kb >= $this->logConfig->rotateSize) {

The property rotateSize does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->runRotate($createdAt, $now);
        }
    }

    /**
     * ログ出力パスを返却する
     * @return string ログ出力パス
     */
    public function getLogPath()
    {
        return $this->logConfig->logPath;

The property logPath does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * ログローテートサイクルを返却する
     * @return string ログ出力パス
     */
    public function getLogRotateCycle()
    {
        return $this->logConfig->rotateCycle;

The property rotateCycle does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * ログローテートサイズを返却する
     * @return string ログ出力パス
     */
    public function getLogRotateSize()
    {
        return $this->logConfig->rotateSize;

The property rotateSize does not exist on object<WebStream\Module\Container>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * 遅延書き出しを有効にする
     */
    public function lazyWrite()
    {
        foreach ($this->outputters as $outputter) {
            if ($outputter instanceof \WebStream\Log\Outputter\ILazyWriter) {
                $outputter->enableLazyWrite();
            }
        }
    }

    /**
     * 即時書き出しを有効にする
     */
    public function directWrite()
    {
        foreach ($this->outputters as $outputter) {
            if ($outputter instanceof \WebStream\Log\Outputter\ILazyWriter) {
                $outputter->enableDirectWrite();
            }
        }
    }
}