Passed
Push — master ( f07cdf...123802 )
by Alexander
23:19 queued 15:07
created

FileTarget::export()   B

Complexity

Conditions 10
Paths 34

Size

Total Lines 35
Code Lines 23

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 19
CRAP Score 10.9037

Importance

Changes 0
Metric Value
cc 10
eloc 23
nc 34
nop 0
dl 0
loc 35
ccs 19
cts 24
cp 0.7917
crap 10.9037
rs 7.6666
c 0
b 0
f 0

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * @link https://www.yiiframework.com/
4
 * @copyright Copyright (c) 2008 Yii Software LLC
5
 * @license https://www.yiiframework.com/license/
6
 */
7
8
namespace yii\log;
9
10
use Yii;
11
use yii\base\InvalidConfigException;
12
use yii\helpers\FileHelper;
13
14
/**
15
 * FileTarget records log messages in a file.
16
 *
17
 * The log file is specified via [[logFile]]. If the size of the log file exceeds
18
 * [[maxFileSize]] (in kilo-bytes), a rotation will be performed, which renames
19
 * the current log file by suffixing the file name with '.1'. All existing log
20
 * files are moved backwards by one place, i.e., '.2' to '.3', '.1' to '.2', and so on.
21
 * The property [[maxLogFiles]] specifies how many history files to keep.
22
 *
23
 * Since 2.0.46 rotation of the files is done only by copy and the
24
 * `rotateByCopy` property is deprecated.
25
 *
26
 * @author Qiang Xue <[email protected]>
27
 * @since 2.0
28
 */
29
class FileTarget extends Target
30
{
31
    /**
32
     * @var string|null log file path or [path alias](guide:concept-aliases). If not set, it will use the "@runtime/logs/app.log" file.
33
     * The directory containing the log files will be automatically created if not existing.
34
     */
35
    public $logFile;
36
    /**
37
     * @var bool whether log files should be rotated when they reach a certain [[maxFileSize|maximum size]].
38
     * Log rotation is enabled by default. This property allows you to disable it, when you have configured
39
     * an external tools for log rotation on your server.
40
     * @since 2.0.3
41
     */
42
    public $enableRotation = true;
43
    /**
44
     * @var int maximum log file size, in kilo-bytes. Defaults to 10240, meaning 10MB.
45
     */
46
    public $maxFileSize = 10240; // in KB
47
    /**
48
     * @var int number of log files used for rotation. Defaults to 5.
49
     */
50
    public $maxLogFiles = 5;
51
    /**
52
     * @var int|null the permission to be set for newly created log files.
53
     * This value will be used by PHP chmod() function. No umask will be applied.
54
     * If not set, the permission will be determined by the current environment.
55
     */
56
    public $fileMode;
57
    /**
58
     * @var int the permission to be set for newly created directories.
59
     * This value will be used by PHP chmod() function. No umask will be applied.
60
     * Defaults to 0775, meaning the directory is read-writable by owner and group,
61
     * but read-only for other users.
62
     */
63
    public $dirMode = 0775;
64
    /**
65
     * @var bool Whether to rotate log files by copy and truncate in contrast to rotation by
66
     * renaming files. Defaults to `true` to be more compatible with log tailers and windows
67
     * systems which do not play well with rename on open files. Rotation by renaming however is
68
     * a bit faster.
69
     *
70
     * The problem with windows systems where the [rename()](https://www.php.net/manual/en/function.rename.php)
71
     * function does not work with files that are opened by some process is described in a
72
     * [comment by Martin Pelletier](https://www.php.net/manual/en/function.rename.php#102274) in
73
     * the PHP documentation. By setting rotateByCopy to `true` you can work
74
     * around this.
75
     * @deprecated since 2.0.46 and setting it to false has no effect anymore
76
     * since rotating is now always done by copy.
77
     */
78
    public $rotateByCopy = true;
79
80
81
    /**
82
     * Initializes the route.
83
     * This method is invoked after the route is created by the route manager.
84
     */
85 2
    public function init()
86
    {
87 2
        parent::init();
88 2
        if ($this->logFile === null) {
89
            $this->logFile = Yii::$app->getRuntimePath() . '/logs/app.log';
90
        } else {
91 2
            $this->logFile = Yii::getAlias($this->logFile);
0 ignored issues
show
Documentation Bug introduced by
It seems like Yii::getAlias($this->logFile) can also be of type false. However, the property $logFile is declared as type null|string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
92
        }
93 2
        if ($this->maxLogFiles < 1) {
94
            $this->maxLogFiles = 1;
95
        }
96 2
        if ($this->maxFileSize < 1) {
97
            $this->maxFileSize = 1;
98
        }
99 2
    }
100
101
    /**
102
     * Writes log messages to a file.
103
     * Starting from version 2.0.14, this method throws LogRuntimeException in case the log can not be exported.
104
     * @throws InvalidConfigException if unable to open the log file for writing
105
     * @throws LogRuntimeException if unable to write complete log to file
106
     */
107 1
    public function export()
108
    {
109 1
        if (strpos($this->logFile, '://') === false || strncmp($this->logFile, 'file://', 7) === 0) {
0 ignored issues
show
Bug introduced by
It seems like $this->logFile can also be of type null; however, parameter $string1 of strncmp() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

109
        if (strpos($this->logFile, '://') === false || strncmp(/** @scrutinizer ignore-type */ $this->logFile, 'file://', 7) === 0) {
Loading history...
Bug introduced by
It seems like $this->logFile can also be of type null; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

109
        if (strpos(/** @scrutinizer ignore-type */ $this->logFile, '://') === false || strncmp($this->logFile, 'file://', 7) === 0) {
Loading history...
110 1
            $logPath = dirname($this->logFile);
0 ignored issues
show
Bug introduced by
It seems like $this->logFile can also be of type null; however, parameter $path of dirname() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

110
            $logPath = dirname(/** @scrutinizer ignore-type */ $this->logFile);
Loading history...
111 1
            FileHelper::createDirectory($logPath, $this->dirMode, true);
112
        }
113
114 1
        $text = implode("\n", array_map([$this, 'formatMessage'], $this->messages)) . "\n";
115 1
        if (($fp = @fopen($this->logFile, 'a')) === false) {
0 ignored issues
show
Bug introduced by
It seems like $this->logFile can also be of type null; however, parameter $filename of fopen() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

115
        if (($fp = @fopen(/** @scrutinizer ignore-type */ $this->logFile, 'a')) === false) {
Loading history...
116
            throw new InvalidConfigException("Unable to append to log file: {$this->logFile}");
117
        }
118 1
        @flock($fp, LOCK_EX);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for flock(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

118
        /** @scrutinizer ignore-unhandled */ @flock($fp, LOCK_EX);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
119 1
        if ($this->enableRotation) {
120
            // clear stat cache to ensure getting the real current file size and not a cached one
121
            // this may result in rotating twice when cached file size is used on subsequent calls
122 1
            clearstatcache();
123
        }
124 1
        if ($this->enableRotation && @filesize($this->logFile) > $this->maxFileSize * 1024) {
0 ignored issues
show
Bug introduced by
It seems like $this->logFile can also be of type null; however, parameter $filename of filesize() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

124
        if ($this->enableRotation && @filesize(/** @scrutinizer ignore-type */ $this->logFile) > $this->maxFileSize * 1024) {
Loading history...
125 1
            $this->rotateFiles();
126
        }
127 1
        $writeResult = @fwrite($fp, $text);
128 1
        if ($writeResult === false) {
129
            $error = error_get_last();
130
            throw new LogRuntimeException("Unable to export log through file ({$this->logFile})!: {$error['message']}");
131
        }
132 1
        $textSize = strlen($text);
133 1
        if ($writeResult < $textSize) {
134
            throw new LogRuntimeException("Unable to export whole log through file ({$this->logFile})! Wrote $writeResult out of $textSize bytes.");
135
        }
136 1
        @fflush($fp);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for fflush(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

136
        /** @scrutinizer ignore-unhandled */ @fflush($fp);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
137 1
        @flock($fp, LOCK_UN);
138 1
        @fclose($fp);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for fclose(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

138
        /** @scrutinizer ignore-unhandled */ @fclose($fp);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
139
140 1
        if ($this->fileMode !== null) {
141
            @chmod($this->logFile, $this->fileMode);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for chmod(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

141
            /** @scrutinizer ignore-unhandled */ @chmod($this->logFile, $this->fileMode);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
Bug introduced by
It seems like $this->logFile can also be of type null; however, parameter $filename of chmod() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

141
            @chmod(/** @scrutinizer ignore-type */ $this->logFile, $this->fileMode);
Loading history...
142
        }
143 1
    }
144
145
    /**
146
     * Rotates log files.
147
     */
148 1
    protected function rotateFiles()
149
    {
150 1
        $file = $this->logFile;
151 1
        for ($i = $this->maxLogFiles; $i >= 0; --$i) {
152
            // $i == 0 is the original log file
153 1
            $rotateFile = $file . ($i === 0 ? '' : '.' . $i);
154 1
            if (is_file($rotateFile)) {
155
                // suppress errors because it's possible multiple processes enter into this section
156 1
                if ($i === $this->maxLogFiles) {
157 1
                    @unlink($rotateFile);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for unlink(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

157
                    /** @scrutinizer ignore-unhandled */ @unlink($rotateFile);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
158 1
                    continue;
159
                }
160 1
                $newFile = $this->logFile . '.' . ($i + 1);
161 1
                $this->rotateByCopy($rotateFile, $newFile);
162 1
                if ($i === 0) {
163 1
                    $this->clearLogFile($rotateFile);
164
                }
165
            }
166
        }
167 1
    }
168
169
    /***
170
     * Clear log file without closing any other process open handles
171
     * @param string $rotateFile
172
     */
173 1
    private function clearLogFile($rotateFile)
174
    {
175 1
        if ($filePointer = @fopen($rotateFile, 'a')) {
176 1
            @ftruncate($filePointer, 0);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for ftruncate(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

176
            /** @scrutinizer ignore-unhandled */ @ftruncate($filePointer, 0);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
177 1
            @fclose($filePointer);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for fclose(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

177
            /** @scrutinizer ignore-unhandled */ @fclose($filePointer);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
178
        }
179 1
    }
180
181
    /***
182
     * Copy rotated file into new file
183
     * @param string $rotateFile
184
     * @param string $newFile
185
     */
186 1
    private function rotateByCopy($rotateFile, $newFile)
187
    {
188 1
        @copy($rotateFile, $newFile);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for copy(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

188
        /** @scrutinizer ignore-unhandled */ @copy($rotateFile, $newFile);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
189 1
        if ($this->fileMode !== null) {
190
            @chmod($newFile, $this->fileMode);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition for chmod(). This can introduce security issues, and is generally not recommended. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unhandled  annotation

190
            /** @scrutinizer ignore-unhandled */ @chmod($newFile, $this->fileMode);

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
191
        }
192 1
    }
193
}
194