LogHelper   A
last analyzed

Complexity

Total Complexity 18

Size/Duplication

Total Lines 141
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 9

Importance

Changes 0
Metric Value
dl 0
loc 141
rs 10
c 0
b 0
f 0
wmc 18
lcom 1
cbo 9

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
F getHandler() 0 118 17
1
<?php
2
3
/*
4
 * This file is part of EC-CUBE
5
 *
6
 * Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
7
 *
8
 * http://www.lockon.co.jp/
9
 *
10
 * This program is free software; you can redistribute it and/or
11
 * modify it under the terms of the GNU General Public License
12
 * as published by the Free Software Foundation; either version 2
13
 * of the License, or (at your option) any later version.
14
 *
15
 * This program is distributed in the hope that it will be useful,
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 * GNU General Public License for more details.
19
 *
20
 * You should have received a copy of the GNU General Public License
21
 * along with this program; if not, write to the Free Software
22
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23
 */
24
25
namespace Eccube\Log\Monolog\Helper;
26
27
use Eccube\Entity\Customer;
28
use Eccube\Entity\Member;
29
use Eccube\Log\Monolog\Processor\IntrospectionProcessor;
30
use Eccube\Log\Monolog\Processor\WebProcessor;
31
use Monolog\Formatter\LineFormatter;
32
use Monolog\Handler\FingersCrossed\ErrorLevelActivationStrategy;
33
use Monolog\Handler\FingersCrossedHandler;
34
use Monolog\Handler\RotatingFileHandler;
35
use Monolog\Logger;
36
use Monolog\Processor\UidProcessor;
37
38
/**
39
 * Handler生成クラス
40
 *
41
 * @package Eccube\Log\Monolog\Helper
42
 */
43
class LogHelper
44
{
45
46
    /** @var  \Eccube\Application */
47
    protected $app;
48
49
    /**
0 ignored issues
show
introduced by
Doc comment for parameter "$app" missing
Loading history...
50
     * EccubeMonologHelper constructor.
51
     *
52
     */
53
    public function __construct($app)
54
    {
55
        $this->app = $app;
56
    }
57
58
    /**
59
     * log.ymlの内容に応じたHandlerの設定を行う
60
     *
61
     * @param array $channelValues
62
     * @return FingersCrossedHandler
63
     */
64
    public function getHandler(array $channelValues)
65
    {
66
        $app = $this->app;
67
68
        $levels = Logger::getLevels();
69
70
        // ファイル名などの設定を行い、設定がなければデフォルト値を設定
71
        $logFileName = isset($channelValues['filename']) ? $channelValues['filename'] : $app['config']['log']['filename'];
72
        $delimiter = isset($channelValues['delimiter']) ? $channelValues['delimiter'] : $app['config']['log']['delimiter'];
73
        $dateFormat = isset($channelValues['dateformat']) ? $channelValues['dateformat'] : $app['config']['log']['dateformat'];
74
        $logLevel = isset($channelValues['log_level']) ? $channelValues['log_level'] : $app['config']['log']['log_level'];
75
        $actionLevel = isset($channelValues['action_level']) ? $channelValues['action_level'] : $app['config']['log']['action_level'];
76
        $passthruLevel = isset($channelValues['passthru_level']) ? $channelValues['passthru_level'] : $app['config']['log']['passthru_level'];
77
        $maxFiles = isset($channelValues['max_files']) ? $channelValues['max_files'] : $app['config']['log']['max_files'];
78
        $logDateFormat = isset($channelValues['log_dateformat']) ? $channelValues['log_dateformat'] : $app['config']['log']['log_dateformat'];
79
        $logFormat = isset($channelValues['log_format']) ? $channelValues['log_format'] : $app['config']['log']['log_format'];
80
81
        if ($app['debug']) {
82
            $level = Logger::DEBUG;
83
        } else {
84
            $level = $logLevel;
85
        }
86
87
88
        // RotateHandlerの設定
89
        $filename = $app['config']['root_dir'].'/app/log/'.$logFileName.'.log';
90
        $RotateHandler = new RotatingFileHandler($filename, $maxFiles, $level);
91
        $RotateHandler->setFilenameFormat(
92
            $logFileName.$delimiter.'{date}'.$app['config']['log']['suffix'],
93
            $dateFormat
94
        );
95
96
        // ログフォーマットの設定(設定ファイルで定義)
97
        $RotateHandler->setFormatter(new LineFormatter($logFormat.PHP_EOL, $logDateFormat, true, true));
98
99
        // FingerCossedHandlerの設定
100
        $FingerCrossedHandler = new FingersCrossedHandler(
101
            $RotateHandler,
0 ignored issues
show
Documentation introduced by
$RotateHandler is of type object<Monolog\Handler\RotatingFileHandler>, but the function expects a callable.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
102
            new ErrorLevelActivationStrategy($levels[$actionLevel]),
103
            0,
104
            true,
105
            true,
106
            $levels[$passthruLevel]
107
        );
108
109
110
        // Processorの内容をログ出力
111
        $webProcessor = new WebProcessor();
112
        $uidProcessor = new UidProcessor(8);
113
114
        $FingerCrossedHandler->pushProcessor(function ($record) use ($app, $uidProcessor, $webProcessor) {
115
            // ログフォーマットに出力する値を独自に設定
116
117
            $record['level_name'] = sprintf("%-5s", $record['level_name']);
118
119
            // セッションIDと会員IDを設定
120
            $record['session_id'] = null;
121
            $record['user_id'] = null;
122
            if ($app->isBooted()) {
123
                if (isset($app['session'])) {
124
                    $sessionId = $app['session']->getId();
125
                    if ($sessionId) {
126
                        $record['session_id'] = substr(sha1($sessionId), 0, 8);
127
                    }
128
                }
129
                if (isset($app['user'])) {
130
                    $user = $app->user();
131
                    if ($user instanceof Customer || $user instanceof Member) {
0 ignored issues
show
Bug introduced by
The class Eccube\Entity\Customer does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
Bug introduced by
The class Eccube\Entity\Member does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
132
                        $record['user_id'] = $user->getId();
133
                    }
134
                }
135
            }
136
137
            $record['uid'] = $uidProcessor->getUid();
138
139
            $record['url'] = $webProcessor->getRequestUri();
140
            $record['ip'] = $webProcessor->getClientIp();
141
            $record['referrer'] = $webProcessor->getReferer();
142
            $record['method'] = $webProcessor->getMethod();
143
            $record['user_agent'] = $webProcessor->getUserAgent();
144
145
            // クラス名などを一旦保持し、不要な情報は削除
146
            $line = $record['extra']['line'];
147
            $functionName = $record['extra']['function'];
148
            // php5.3だとclass名が取得できないため、ファイル名を元に出力
149
            // $className = $record['extra']['class'];
0 ignored issues
show
Unused Code Comprehensibility introduced by
70% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
150
            $className = $record['extra']['file'];
151
152
            // 不要な情報を削除
153
            unset($record['extra']['file']);
154
            unset($record['extra']['line']);
155
            unset($record['extra']['class']);
156
            unset($record['extra']['function']);
157
158
            $record['class'] = pathinfo($className, PATHINFO_FILENAME);
159
            $record['function'] = $functionName;
160
            $record['line'] = $line;
161
162
            return $record;
163
        });
164
165
        // クラス名等を取得するProcessor、ログ出力時にクラス名/関数名を無視するための設定を行っている
166
        $skipClasses = array('Psr\\Log\\', 'Eccube\\Log\\');
167
        $skipFunctions = array(
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
168
            'log_info',
169
            'log_notice',
170
            'log_warning',
171
            'log_error',
172
            'log_critical',
173
            'log_alert',
174
            'log_emergency'
175
        );
176
        $intro = new IntrospectionProcessor(Logger::DEBUG, $skipClasses, $skipFunctions);
177
        $FingerCrossedHandler->pushProcessor($intro);
178
179
        return $FingerCrossedHandler;
180
181
    }
182
183
}
184