|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * Copyright © Magento, Inc. All rights reserved. |
| 4 | + * See COPYING.txt for license details. |
| 5 | + */ |
| 6 | +declare(strict_types=1); |
| 7 | + |
| 8 | +namespace Magento\MagentoCloud\Config\Validator\Build; |
| 9 | + |
| 10 | +use Magento\MagentoCloud\App\Error; |
| 11 | +use Magento\MagentoCloud\Config\Validator; |
| 12 | +use Magento\MagentoCloud\Config\ValidatorInterface; |
| 13 | +use Magento\MagentoCloud\Filesystem\Driver\File; |
| 14 | +use Magento\MagentoCloud\Filesystem\FileList; |
| 15 | + |
| 16 | +/** |
| 17 | + * Checks that required paths to exclude for OPCache are present. |
| 18 | + */ |
| 19 | +class OpcacheExcludePaths implements ValidatorInterface |
| 20 | +{ |
| 21 | + /** |
| 22 | + * @var File |
| 23 | + */ |
| 24 | + private $file; |
| 25 | + |
| 26 | + /** |
| 27 | + * @var FileList |
| 28 | + */ |
| 29 | + private $fileList; |
| 30 | + |
| 31 | + /** |
| 32 | + * @var Validator\ResultFactory |
| 33 | + */ |
| 34 | + private $resultFactory; |
| 35 | + |
| 36 | + /** |
| 37 | + * @param File $file |
| 38 | + * @param FileList $fileList |
| 39 | + * @param Validator\ResultFactory $resultFactory |
| 40 | + */ |
| 41 | + public function __construct( |
| 42 | + File $file, |
| 43 | + FileList $fileList, |
| 44 | + Validator\ResultFactory $resultFactory |
| 45 | + ) { |
| 46 | + $this->file = $file; |
| 47 | + $this->fileList = $fileList; |
| 48 | + $this->resultFactory = $resultFactory; |
| 49 | + } |
| 50 | + |
| 51 | + /** |
| 52 | + * Checks if php.ini and op-exclude.txt are present, and they contain needed configuration |
| 53 | + * |
| 54 | + * {@inheritdoc} |
| 55 | + */ |
| 56 | + public function validate(): Validator\ResultInterface |
| 57 | + { |
| 58 | + $phpIni = $this->fileList->getPhpIni(); |
| 59 | + $excludeList = $this->fileList->getOpCacheExcludeList(); |
| 60 | + |
| 61 | + // Checks if files are present |
| 62 | + if (!$this->file->isExists($phpIni) || !$this->file->isExists($excludeList)) { |
| 63 | + return $this->resultFactory->error( |
| 64 | + 'File php.ini or op-exclude.txt does not exist', |
| 65 | + 'Check if your cloud template contains latest php.ini and op-exclude.txt files', |
| 66 | + Error::WARN_WRONG_OPCACHE_CONFIG |
| 67 | + ); |
| 68 | + } |
| 69 | + |
| 70 | + // Checks if the php.ini file contains correct path to the op-exclude.txt file |
| 71 | + $parsedPhpIni = (array) $this->file->parseIni($phpIni); |
| 72 | + |
| 73 | + if (!(array_key_exists('opcache.blacklist_filename', $parsedPhpIni) |
| 74 | + && $parsedPhpIni['opcache.blacklist_filename'] == $excludeList)) { |
| 75 | + return $this->resultFactory->error( |
| 76 | + 'File php.ini does not contain opcache.blacklist_filename configuration', |
| 77 | + 'Check if your cloud template contains latest php.ini configuration file' |
| 78 | + . ' https://github.com/magento/magento-cloud/blob/master/php.ini', |
| 79 | + Error::WARN_WRONG_OPCACHE_CONFIG |
| 80 | + ); |
| 81 | + } |
| 82 | + |
| 83 | + // Checks if the op-exclude.txt file contains all needed paths to exclude for OPCache |
| 84 | + $diff = array_diff( |
| 85 | + [ |
| 86 | + '/app/*/app/etc/config.php', |
| 87 | + '/app/*/app/etc/env.php', |
| 88 | + '/app/app/etc/config.php', |
| 89 | + '/app/app/etc/env.php', |
| 90 | + '/app/etc/config.php', |
| 91 | + '/app/etc/env.php' |
| 92 | + ], |
| 93 | + explode(PHP_EOL, (string) $this->file->fileGetContents($excludeList)) |
| 94 | + ); |
| 95 | + |
| 96 | + if (!empty($diff)) { |
| 97 | + return $this->resultFactory->error( |
| 98 | + 'File op-exclude.txt does not contain required paths to exclude for OPCache', |
| 99 | + 'Check if your op-exclude.txt contains the next paths:' . PHP_EOL |
| 100 | + . implode(PHP_EOL, $diff), |
| 101 | + Error::WARN_WRONG_OPCACHE_CONFIG |
| 102 | + ); |
| 103 | + } |
| 104 | + |
| 105 | + return $this->resultFactory->create(Validator\ResultInterface::SUCCESS); |
| 106 | + } |
| 107 | +} |
0 commit comments