These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | /** |
||
3 | * View.php |
||
4 | * @author Revin Roman |
||
5 | * @link https://rmrevin.ru |
||
6 | */ |
||
7 | |||
8 | namespace rmrevin\yii\minify; |
||
9 | |||
10 | use yii\helpers; |
||
11 | |||
12 | /** |
||
13 | * Class View |
||
14 | * @package rmrevin\yii\minify |
||
15 | */ |
||
16 | class View extends \yii\web\View |
||
17 | { |
||
18 | |||
19 | /** @var bool */ |
||
20 | public $enableMinify = true; |
||
21 | |||
22 | /** @var bool */ |
||
23 | public $minifyCss = true; |
||
24 | |||
25 | /** @var bool */ |
||
26 | public $minifyJs = true; |
||
27 | |||
28 | /** @var bool */ |
||
29 | public $removeComments = true; |
||
30 | |||
31 | /** @var string path alias to web base (in url) */ |
||
32 | public $web_path = '@web'; |
||
33 | |||
34 | /** @var string path alias to web base (absolute) */ |
||
35 | public $base_path = '@webroot'; |
||
36 | |||
37 | /** @var string path alias to save minify result */ |
||
38 | public $minify_path = '@webroot/minify'; |
||
39 | |||
40 | /** @var array positions of js files to be minified */ |
||
41 | public $js_position = [self::POS_END, self::POS_HEAD]; |
||
42 | |||
43 | /** @var bool|string charset forcibly assign, otherwise will use all of the files found charset */ |
||
44 | public $force_charset = false; |
||
45 | |||
46 | /** @var bool whether to change @import on content */ |
||
47 | public $expand_imports = true; |
||
48 | |||
49 | /** @var int */ |
||
50 | public $css_linebreak_pos = 2048; |
||
51 | |||
52 | /** @var int|bool chmod of minified file. If false chmod not set */ |
||
53 | public $file_mode = 0664; |
||
54 | |||
55 | /** @var array schemes that will be ignored during normalization url */ |
||
56 | public $schemas = ['//', 'http://', 'https://', 'ftp://']; |
||
57 | |||
58 | /** @var bool do I need to compress the result html page. */ |
||
59 | public $compress_output = false; |
||
60 | |||
61 | /** |
||
62 | * @var array options for compressing output result |
||
63 | * * extra - use more compact algorithm |
||
64 | * * no-comments - cut all the html comments |
||
65 | */ |
||
66 | public $compress_options = ['extra' => true]; |
||
67 | |||
68 | /** |
||
69 | * @throws \rmrevin\yii\minify\Exception |
||
70 | */ |
||
71 | 6 | public function init() |
|
72 | { |
||
73 | 6 | parent::init(); |
|
74 | |||
75 | 6 | $minify_path = $this->minify_path = (string)\Yii::getAlias($this->minify_path); |
|
76 | 6 | if (!file_exists($minify_path)) { |
|
77 | 6 | helpers\FileHelper::createDirectory($minify_path); |
|
78 | 6 | } |
|
79 | |||
80 | 6 | if (!is_readable($minify_path)) { |
|
81 | throw new Exception('Directory for compressed assets is not readable.'); |
||
82 | } |
||
83 | |||
84 | 6 | if (!is_writable($minify_path)) { |
|
85 | throw new Exception('Directory for compressed assets is not writable.'); |
||
86 | } |
||
87 | |||
88 | 6 | if (true === $this->compress_output) { |
|
89 | \Yii::$app->response->on(\yii\web\Response::EVENT_BEFORE_SEND, function (\yii\base\Event $Event) { |
||
90 | /** @var \yii\web\Response $Response */ |
||
91 | $Response = $Event->sender; |
||
92 | if ($Response->format === \yii\web\Response::FORMAT_HTML) { |
||
93 | if (!empty($Response->data)) { |
||
94 | $Response->data = HtmlCompressor::compress($Response->data, $this->compress_options); |
||
95 | } |
||
96 | |||
97 | if (!empty($Response->content)) { |
||
98 | $Response->content = HtmlCompressor::compress($Response->content, $this->compress_options); |
||
0 ignored issues
–
show
|
|||
99 | } |
||
100 | } |
||
101 | }); |
||
102 | } |
||
103 | 6 | } |
|
104 | |||
105 | /** |
||
106 | * @inheritdoc |
||
107 | */ |
||
108 | 4 | public function endPage($ajaxMode = false) |
|
109 | { |
||
110 | 4 | $this->trigger(self::EVENT_END_PAGE); |
|
111 | |||
112 | 4 | $content = ob_get_clean(); |
|
113 | 4 | foreach (array_keys($this->assetBundles) as $bundle) { |
|
114 | 4 | $this->registerAssetFiles($bundle); |
|
115 | 4 | } |
|
116 | |||
117 | 4 | if (true === $this->enableMinify) { |
|
118 | 4 | if (true === $this->minifyCss) { |
|
119 | 4 | $this->minifyCSS(); |
|
120 | 4 | } |
|
121 | |||
122 | 4 | if (true === $this->minifyJs) { |
|
123 | 4 | $this->minifyJS(); |
|
124 | 4 | } |
|
125 | 4 | } |
|
126 | |||
127 | 4 | echo strtr( |
|
128 | 4 | $content, |
|
129 | [ |
||
130 | 4 | self::PH_HEAD => $this->renderHeadHtml(), |
|
131 | 4 | self::PH_BODY_BEGIN => $this->renderBodyBeginHtml(), |
|
132 | 4 | self::PH_BODY_END => $this->renderBodyEndHtml($ajaxMode), |
|
133 | ] |
||
134 | 4 | ); |
|
135 | |||
136 | 4 | $this->clear(); |
|
137 | 4 | } |
|
138 | |||
139 | /** |
||
140 | * @return self |
||
141 | */ |
||
142 | 4 | protected function minifyCSS() |
|
143 | { |
||
144 | 4 | if (!empty($this->cssFiles)) { |
|
145 | 4 | $cssFiles = $this->cssFiles; |
|
146 | |||
147 | 4 | $this->cssFiles = []; |
|
148 | |||
149 | 4 | $toMinify = []; |
|
150 | |||
151 | 4 | View Code Duplication | foreach ($cssFiles as $file => $html) { |
0 ignored issues
–
show
This code seems to be duplicated across your project.
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. ![]() |
|||
152 | 4 | if ($this->thisFileNeedMinify($file, $html)) { |
|
153 | 4 | $toMinify[$file] = $html; |
|
154 | 4 | } else { |
|
155 | if (!empty($toMinify)) { |
||
156 | $this->processMinifyCss($toMinify); |
||
157 | |||
158 | $toMinify = []; |
||
159 | } |
||
160 | |||
161 | $this->cssFiles[$file] = $html; |
||
162 | } |
||
163 | 4 | } |
|
164 | |||
165 | 4 | if (!empty($toMinify)) { |
|
166 | 4 | $this->processMinifyCss($toMinify); |
|
167 | 4 | } |
|
168 | |||
169 | 4 | unset($toMinify); |
|
170 | 4 | } |
|
171 | |||
172 | 4 | return $this; |
|
173 | } |
||
174 | |||
175 | /** |
||
176 | * @param array $files |
||
177 | */ |
||
178 | 4 | protected function processMinifyCss($files) |
|
179 | { |
||
180 | 4 | $resultFile = $this->minify_path . '/' . $this->_getSummaryFilesHash($files) . '.css'; |
|
181 | |||
182 | 4 | if (!file_exists($resultFile)) { |
|
183 | 4 | $css = ''; |
|
184 | |||
185 | 4 | foreach ($files as $file => $html) { |
|
186 | 4 | $path = dirname($file); |
|
187 | 4 | $file = $this->getAbsoluteFilePath($file); |
|
188 | |||
189 | 4 | $content = file_get_contents($file); |
|
190 | |||
191 | 4 | preg_match_all('|url\(([^)]+)\)|is', $content, $m); |
|
192 | 4 | if (!empty($m[0])) { |
|
193 | 4 | $result = []; |
|
194 | |||
195 | 4 | foreach ($m[0] as $k => $v) { |
|
196 | 4 | if (in_array(strpos($m[1][$k], 'data:'), [0, 1], true)) { |
|
197 | 4 | continue; |
|
198 | } |
||
199 | |||
200 | 4 | $url = str_replace(['\'', '"'], '', $m[1][$k]); |
|
201 | |||
202 | 4 | if ($this->isUrl($url)) { |
|
203 | 4 | $result[$m[1][$k]] = '\'' . $url . '\''; |
|
204 | 4 | } else { |
|
205 | 4 | $result[$m[1][$k]] = '\'' . $path . '/' . $url . '\''; |
|
206 | } |
||
207 | 4 | } |
|
208 | |||
209 | 4 | $content = str_replace(array_keys($result), array_values($result), $content); |
|
210 | 4 | } |
|
211 | |||
212 | 4 | $css .= $content; |
|
213 | 4 | } |
|
214 | |||
215 | 4 | $this->expandImports($css); |
|
216 | |||
217 | 4 | $this->removeCssComments($css); |
|
218 | |||
219 | 4 | $css = (new \CSSmin()) |
|
220 | 4 | ->run($css, $this->css_linebreak_pos); |
|
221 | |||
222 | 4 | if (false !== $this->force_charset) { |
|
223 | 2 | $charsets = '@charset "' . (string)$this->force_charset . '";' . "\n"; |
|
224 | 2 | } else { |
|
225 | 2 | $charsets = $this->collectCharsets($css); |
|
226 | } |
||
227 | |||
228 | 4 | $imports = $this->collectImports($css); |
|
229 | 4 | $fonts = $this->collectFonts($css); |
|
230 | |||
231 | 4 | file_put_contents($resultFile, $charsets . $imports . $fonts . $css); |
|
232 | |||
233 | 4 | if (false !== $this->file_mode) { |
|
234 | 4 | @chmod($resultFile, $this->file_mode); |
|
0 ignored issues
–
show
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.
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.');
}
![]() |
|||
235 | 4 | } |
|
236 | 4 | } |
|
237 | |||
238 | 4 | $file = sprintf('%s%s', \Yii::getAlias($this->web_path), str_replace(\Yii::getAlias($this->base_path), '', $resultFile)); |
|
239 | |||
240 | 4 | $this->cssFiles[$file] = helpers\Html::cssFile($file); |
|
241 | 4 | } |
|
242 | |||
243 | /** |
||
244 | * @return self |
||
245 | */ |
||
246 | 4 | protected function minifyJS() |
|
247 | { |
||
248 | 4 | if (!empty($this->jsFiles)) { |
|
249 | 4 | $jsFiles = $this->jsFiles; |
|
250 | |||
251 | 4 | foreach ($jsFiles as $position => $files) { |
|
252 | 4 | if (false === in_array($position, $this->js_position, true)) { |
|
253 | 4 | $this->jsFiles[$position] = []; |
|
254 | 4 | foreach ($files as $file => $html) { |
|
255 | 4 | $this->jsFiles[$position][$file] = $html; |
|
256 | 4 | } |
|
257 | 4 | } else { |
|
258 | 4 | $this->jsFiles[$position] = []; |
|
259 | |||
260 | 4 | $toMinify = []; |
|
261 | |||
262 | 4 | View Code Duplication | foreach ($files as $file => $html) { |
0 ignored issues
–
show
This code seems to be duplicated across your project.
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. ![]() |
|||
263 | 4 | if ($this->thisFileNeedMinify($file, $html)) { |
|
264 | 4 | $toMinify[$file] = $html; |
|
265 | 4 | } else { |
|
266 | 4 | if (!empty($toMinify)) { |
|
267 | $this->processMinifyJs($position, $toMinify); |
||
268 | |||
269 | $toMinify = []; |
||
270 | } |
||
271 | |||
272 | 4 | $this->jsFiles[$position][$file] = $html; |
|
273 | } |
||
274 | 4 | } |
|
275 | |||
276 | 4 | if (!empty($toMinify)) { |
|
277 | 4 | $this->processMinifyJs($position, $toMinify); |
|
278 | 4 | } |
|
279 | |||
280 | 4 | unset($toMinify); |
|
281 | } |
||
282 | 4 | } |
|
283 | 4 | } |
|
284 | |||
285 | 4 | return $this; |
|
286 | } |
||
287 | |||
288 | /** |
||
289 | * @param integer $position |
||
290 | * @param array $files |
||
291 | */ |
||
292 | 4 | protected function processMinifyJs($position, $files) |
|
293 | { |
||
294 | 4 | $resultFile = sprintf('%s/%s.js', $this->minify_path, $this->_getSummaryFilesHash($files)); |
|
295 | 4 | if (!file_exists($resultFile)) { |
|
296 | 4 | $js = ''; |
|
297 | 4 | foreach ($files as $file => $html) { |
|
298 | 4 | $file = $this->getAbsoluteFilePath($file); |
|
299 | 4 | $js .= file_get_contents($file) . ';' . PHP_EOL; |
|
300 | 4 | } |
|
301 | |||
302 | 4 | $this->removeJsComments($js); |
|
0 ignored issues
–
show
The call to the method
rmrevin\yii\minify\View::removeJsComments() seems un-needed as the method has no side-effects.
PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User
{
private $email;
public function getEmail()
{
return $this->email;
}
public function setEmail($email)
{
$this->email = $email;
}
}
If we look at the $user = new User();
$user->getEmail(); // This line could safely be removed as it has no effect.
On the hand, if we look at the $user = new User();
$user->setEmail('email@domain'); // This line has a side-effect (it changes an
// instance variable).
![]() |
|||
303 | |||
304 | 4 | $compressedJs = (new \JSMin($js)) |
|
305 | 4 | ->min(); |
|
306 | |||
307 | 4 | file_put_contents($resultFile, $compressedJs); |
|
308 | |||
309 | 4 | if (false !== $this->file_mode) { |
|
310 | 4 | @chmod($resultFile, $this->file_mode); |
|
0 ignored issues
–
show
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.
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.');
}
![]() |
|||
311 | 4 | } |
|
312 | 4 | } |
|
313 | |||
314 | 4 | $file = sprintf('%s%s', \Yii::getAlias($this->web_path), str_replace(\Yii::getAlias($this->base_path), '', $resultFile)); |
|
315 | |||
316 | 4 | $this->jsFiles[$position][$file] = helpers\Html::jsFile($file); |
|
317 | 4 | } |
|
318 | |||
319 | /** |
||
320 | * @param string $url |
||
321 | * @param boolean $checkSlash |
||
322 | * @return bool |
||
323 | */ |
||
324 | 4 | protected function isUrl($url, $checkSlash = true) |
|
325 | { |
||
326 | 4 | $regexp = '#^(' . implode('|', $this->schemas) . ')#is'; |
|
327 | 4 | if ($checkSlash) { |
|
328 | 4 | $regexp = '#^(/|\\\\|' . implode('|', $this->schemas) . ')#is'; |
|
329 | 4 | } |
|
330 | |||
331 | 4 | return (bool)preg_match($regexp, $url); |
|
332 | } |
||
333 | |||
334 | /** |
||
335 | * @param string $string |
||
336 | * @return bool |
||
337 | */ |
||
338 | 4 | protected function isContainsConditionalComment($string) |
|
339 | { |
||
340 | 4 | return strpos($string, '<![endif]-->') !== false; |
|
341 | } |
||
342 | |||
343 | /** |
||
344 | * @param string $file |
||
345 | * @param string $html |
||
346 | * @return bool |
||
347 | */ |
||
348 | 4 | protected function thisFileNeedMinify($file, $html) |
|
349 | { |
||
350 | 4 | return !$this->isUrl($file, false) && !$this->isContainsConditionalComment($html); |
|
351 | } |
||
352 | |||
353 | /** |
||
354 | * @param string $code |
||
355 | * @return string |
||
356 | */ |
||
357 | 2 | protected function collectCharsets(&$code) |
|
358 | { |
||
359 | return $this->_collect($code, '|\@charset[^;]+|is', function ($string) { |
||
360 | 2 | return $string . ';'; |
|
361 | 2 | }); |
|
362 | } |
||
363 | |||
364 | /** |
||
365 | * @param string $code |
||
366 | * @return string |
||
367 | */ |
||
368 | 4 | protected function collectImports(&$code) |
|
369 | { |
||
370 | return $this->_collect($code, '|\@import[^;]+|is', function ($string) { |
||
371 | 2 | return $string . ';'; |
|
372 | 4 | }); |
|
373 | } |
||
374 | |||
375 | /** |
||
376 | * @param string $code |
||
377 | * @return string |
||
378 | */ |
||
379 | protected function collectFonts(&$code) |
||
380 | { |
||
381 | 4 | return $this->_collect($code, '|\@font-face\{[^}]+\}|is', function ($string) { |
|
382 | 2 | return $string; |
|
383 | 4 | }); |
|
384 | } |
||
385 | |||
386 | /** |
||
387 | * @param string $code |
||
388 | */ |
||
389 | 4 | protected function removeCssComments(&$code) |
|
390 | { |
||
391 | 4 | if (true === $this->removeComments) { |
|
392 | 4 | $code = preg_replace('#/\*(?:[^*]*(?:\*(?!/))*)*\*/#', '', $code); |
|
393 | 4 | } |
|
394 | 4 | } |
|
395 | |||
396 | /** |
||
397 | * @param string $code |
||
398 | */ |
||
399 | 4 | protected function removeJsComments(&$code) |
|
0 ignored issues
–
show
|
|||
400 | { |
||
401 | // @todo |
||
402 | 4 | if (true === $this->removeComments) { |
|
0 ignored issues
–
show
This
if statement is empty and can be removed.
This check looks for the bodies of These if (rand(1, 6) > 3) {
//print "Check failed";
} else {
print "Check succeeded";
}
could be turned into if (rand(1, 6) <= 3) {
print "Check succeeded";
}
This is much more concise to read. ![]() |
|||
403 | //$code = preg_replace('', '', $code); |
||
0 ignored issues
–
show
Unused Code
Comprehensibility
introduced
by
60% 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. ![]() |
|||
404 | 4 | } |
|
405 | 4 | } |
|
406 | |||
407 | /** |
||
408 | * @param string $code |
||
409 | */ |
||
410 | 4 | protected function expandImports(&$code) |
|
411 | { |
||
412 | 4 | if (true === $this->expand_imports) { |
|
413 | 2 | preg_match_all('|\@import\s([^;]+);|is', str_replace('&', '&', $code), $m); |
|
414 | 2 | if (!empty($m[0])) { |
|
415 | 2 | foreach ($m[0] as $k => $v) { |
|
416 | 2 | $import_url = $m[1][$k]; |
|
417 | 2 | if (!empty($import_url)) { |
|
418 | 2 | $import_content = $this->_getImportContent($import_url); |
|
419 | 2 | if (!empty($import_content)) { |
|
420 | 2 | $code = str_replace($m[0][$k], $import_content, $code); |
|
421 | 2 | } |
|
422 | 2 | } |
|
423 | 2 | } |
|
424 | 2 | } |
|
425 | 2 | } |
|
426 | 4 | } |
|
427 | |||
428 | /** |
||
429 | * @param string $url |
||
430 | * @return null|string |
||
431 | */ |
||
432 | 2 | protected function _getImportContent($url) |
|
433 | { |
||
434 | 2 | $result = null; |
|
435 | |||
436 | 2 | if ('url(' === helpers\StringHelper::byteSubstr($url, 0, 4)) { |
|
437 | 2 | $url = str_replace(['url(\'', 'url("', 'url(', '\')', '")', ')'], '', $url); |
|
438 | |||
439 | 2 | if (helpers\StringHelper::byteSubstr($url, 0, 2) === '//') { |
|
440 | 2 | $url = preg_replace('|^//|', 'http://', $url, 1); |
|
441 | 2 | } |
|
442 | |||
443 | 2 | if (!empty($url)) { |
|
444 | 2 | $result = file_get_contents($url); |
|
445 | 2 | } |
|
446 | 2 | } |
|
447 | |||
448 | 2 | return $result; |
|
449 | } |
||
450 | |||
451 | /** |
||
452 | * @param string $code |
||
453 | * @param string $pattern |
||
454 | * @param callable $handler |
||
455 | * @return string |
||
456 | */ |
||
457 | 4 | protected function _collect(&$code, $pattern, $handler) |
|
458 | { |
||
459 | 4 | $result = ''; |
|
460 | |||
461 | 4 | preg_match_all($pattern, $code, $m); |
|
462 | 4 | foreach ($m[0] as $string) { |
|
463 | 4 | $string = $handler($string); |
|
464 | 4 | $code = str_replace($string, '', $code); |
|
465 | |||
466 | 4 | $result .= $string . PHP_EOL; |
|
467 | 4 | } |
|
468 | |||
469 | 4 | return $result; |
|
470 | } |
||
471 | |||
472 | /** |
||
473 | * @param string $file |
||
474 | * @return string |
||
475 | */ |
||
476 | 4 | protected function cleanFileName($file) |
|
477 | { |
||
478 | 4 | return (strpos($file, '?')) ? parse_url($file, PHP_URL_PATH) : $file; |
|
479 | } |
||
480 | |||
481 | /** |
||
482 | * @param string $file |
||
483 | * @return string |
||
484 | */ |
||
485 | 4 | protected function getAbsoluteFilePath($file) |
|
486 | { |
||
487 | 4 | return \Yii::getAlias($this->base_path) . str_replace(\Yii::getAlias($this->web_path), '', $this->cleanFileName($file)); |
|
488 | } |
||
489 | |||
490 | /** |
||
491 | * @param array $files |
||
492 | * @return string |
||
493 | */ |
||
494 | 4 | protected function _getSummaryFilesHash($files) |
|
495 | { |
||
496 | 4 | $result = ''; |
|
497 | 4 | foreach ($files as $file => $html) { |
|
498 | 4 | $path = $this->getAbsoluteFilePath($file); |
|
499 | |||
500 | 4 | if ($this->thisFileNeedMinify($file, $html) && file_exists($path)) { |
|
501 | 4 | $result .= sha1_file($path); |
|
502 | 4 | } |
|
503 | 4 | } |
|
504 | |||
505 | 4 | return sha1($result); |
|
506 | } |
||
507 | } |
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 theid
property of an instance of theAccount
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.