YiiRequirementChecker.php 13.2 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

8
if (version_compare(PHP_VERSION, '4.3', '<')) {
9 10
    echo 'At least PHP 4.3 is required to run this script!';
    exit(1);
11 12
}

13
/**
14 15
 * YiiRequirementChecker allows checking, if current system meets the requirements for running the Yii application.
 * This class allows rendering of the check report for the web and console application interface.
16
 *
17
 * Example:
18
 *
19
 * ~~~php
20
 * require_once('path/to/YiiRequirementChecker.php');
21
 * $requirementsChecker = new YiiRequirementChecker();
22 23
 * $requirements = array(
 *     array(
24 25 26 27 28
 *         'name' => 'PHP Some Extension',
 *         'mandatory' => true,
 *         'condition' => extension_loaded('some_extension'),
 *         'by' => 'Some application feature',
 *         'memo' => 'PHP extension "some_extension" required',
29 30
 *     ),
 * );
31
 * $requirementsChecker->checkYii()->check($requirements)->render();
32
 * ~~~
33 34 35 36 37 38
 *
 * If you wish to render the report with your own representation, use [[getResult()]] instead of [[render()]]
 *
 * Requirement condition could be in format "eval:PHP expression".
 * In this case specified PHP expression will be evaluated in the context of this class instance.
 * For example:
39 40
 *
 * ~~~
41 42
 * $requirements = array(
 *     array(
43 44
 *         'name' => 'Upload max file size',
 *         'condition' => 'eval:$this->checkUploadMaxFileSize("5M")',
45 46
 *     ),
 * );
47
 * ~~~
48
 *
49
 * Note: this class definition does not match ordinary Yii style, because it should match PHP 4.3
50
 * and should not use features from newer PHP versions!
51
 *
52
 * @property array|null $result the check results, this property is for internal usage only.
53
 *
54 55 56 57 58
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class YiiRequirementChecker
{
59 60 61 62
    /**
     * Check the given requirements, collecting results into internal field.
     * This method can be invoked several times checking different requirement sets.
     * Use [[getResult()]] or [[render()]] to get the results.
63 64 65 66
     * @param array|string $requirements requirements to be checked.
     * If an array, it is treated as the set of requirements;
     * If a string, it is treated as the path of the file, which contains the requirements;
     * @return static self instance.
67
     */
68
    function check($requirements)
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    {
        if (is_string($requirements)) {
            $requirements = require($requirements);
        }
        if (!is_array($requirements)) {
            $this->usageError('Requirements must be an array, "' . gettype($requirements) . '" has been given!');
        }
        if (!isset($this->result) || !is_array($this->result)) {
            $this->result = array(
                'summary' => array(
                    'total' => 0,
                    'errors' => 0,
                    'warnings' => 0,
                ),
                'requirements' => array(),
            );
        }
        foreach ($requirements as $key => $rawRequirement) {
            $requirement = $this->normalizeRequirement($rawRequirement, $key);
            $this->result['summary']['total']++;
            if (!$requirement['condition']) {
                if ($requirement['mandatory']) {
                    $requirement['error'] = true;
                    $requirement['warning'] = true;
                    $this->result['summary']['errors']++;
                } else {
                    $requirement['error'] = false;
                    $requirement['warning'] = true;
                    $this->result['summary']['warnings']++;
                }
            } else {
                $requirement['error'] = false;
                $requirement['warning'] = false;
            }
            $this->result['requirements'][] = $requirement;
        }
105

106 107
        return $this;
    }
108

109 110 111 112
    /**
     * Performs the check for the Yii core requirements.
     * @return YiiRequirementChecker self instance.
     */
113
    function checkYii()
114 115 116
    {
        return $this->check(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'requirements.php');
    }
117

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
    /**
     * Return the check results.
     * @return array|null check results in format:
     *
     * ```php
     * array(
     *     'summary' => array(
     *         'total' => total number of checks,
     *         'errors' => number of errors,
     *         'warnings' => number of warnings,
     *     ),
     *     'requirements' => array(
     *         array(
     *             ...
     *             'error' => is there an error,
     *             'warning' => is there a warning,
     *         ),
     *         ...
     *     ),
     * )
     * ```
     */
140
    function getResult()
141 142 143 144 145 146 147
    {
        if (isset($this->result)) {
            return $this->result;
        } else {
            return null;
        }
    }
148

149 150 151 152
    /**
     * Renders the requirements check result.
     * The output will vary depending is a script running from web or from console.
     */
153
    function render()
154 155 156 157 158 159 160 161 162 163 164 165
    {
        if (!isset($this->result)) {
            $this->usageError('Nothing to render!');
        }
        $baseViewFilePath = dirname(__FILE__) . DIRECTORY_SEPARATOR . 'views';
        if (!empty($_SERVER['argv'])) {
            $viewFileName = $baseViewFilePath . DIRECTORY_SEPARATOR . 'console' . DIRECTORY_SEPARATOR . 'index.php';
        } else {
            $viewFileName = $baseViewFilePath . DIRECTORY_SEPARATOR . 'web' . DIRECTORY_SEPARATOR . 'index.php';
        }
        $this->renderViewFile($viewFileName, $this->result);
    }
166

167 168
    /**
     * Checks if the given PHP extension is available and its version matches the given one.
169 170 171
     * @param string $extensionName PHP extension name.
     * @param string $version required PHP extension version.
     * @param string $compare comparison operator, by default '>='
172 173
     * @return boolean if PHP extension version matches.
     */
174
    function checkPhpExtensionVersion($extensionName, $version, $compare = '>=')
175 176 177 178 179 180 181 182 183 184 185
    {
        if (!extension_loaded($extensionName)) {
            return false;
        }
        $extensionVersion = phpversion($extensionName);
        if (empty($extensionVersion)) {
            return false;
        }
        if (strncasecmp($extensionVersion, 'PECL-', 5) == 0) {
            $extensionVersion = substr($extensionVersion, 5);
        }
186

187 188
        return version_compare($extensionVersion, $version, $compare);
    }
189

190 191
    /**
     * Checks if PHP configuration option (from php.ini) is on.
192
     * @param string $name configuration option name.
193 194
     * @return boolean option is on.
     */
195
    function checkPhpIniOn($name)
196 197 198 199 200
    {
        $value = ini_get($name);
        if (empty($value)) {
            return false;
        }
201

202 203
        return ((integer) $value == 1 || strtolower($value) == 'on');
    }
204

205 206
    /**
     * Checks if PHP configuration option (from php.ini) is off.
207
     * @param string $name configuration option name.
208 209
     * @return boolean option is off.
     */
210
    function checkPhpIniOff($name)
211 212 213 214 215
    {
        $value = ini_get($name);
        if (empty($value)) {
            return true;
        }
216

217 218
        return (strtolower($value) == 'off');
    }
219

220 221 222
    /**
     * Compare byte sizes of values given in the verbose representation,
     * like '5M', '15K' etc.
223 224 225
     * @param string $a first value.
     * @param string $b second value.
     * @param string $compare comparison operator, by default '>='.
226 227
     * @return boolean comparison result.
     */
228
    function compareByteSize($a, $b, $compare = '>=')
229 230
    {
        $compareExpression = '(' . $this->getByteSize($a) . $compare . $this->getByteSize($b) . ')';
231

232 233
        return $this->evaluateExpression($compareExpression);
    }
234

235 236 237
    /**
     * Gets the size in bytes from verbose size representation.
     * For example: '5K' => 5*1024
238
     * @param string $verboseSize verbose size representation.
239 240
     * @return integer actual size in bytes.
     */
241
    function getByteSize($verboseSize)
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
    {
        if (empty($verboseSize)) {
            return 0;
        }
        if (is_numeric($verboseSize)) {
            return (integer) $verboseSize;
        }
        $sizeUnit = trim($verboseSize, '0123456789');
        $size = str_replace($sizeUnit, '', $verboseSize);
        $size = trim($size);
        if (!is_numeric($size)) {
            return 0;
        }
        switch (strtolower($sizeUnit)) {
            case 'kb':
            case 'k': {
                return $size * 1024;
            }
            case 'mb':
            case 'm': {
                return $size * 1024 * 1024;
            }
            case 'gb':
            case 'g': {
                return $size * 1024 * 1024 * 1024;
            }
            default: {
                return 0;
            }
        }
    }
273

274 275
    /**
     * Checks if upload max file size matches the given range.
276 277 278
     * @param string|null $min verbose file size minimum required value, pass null to skip minimum check.
     * @param string|null $max verbose file size maximum required value, pass null to skip maximum check.
     * @return boolean success.
279
     */
280
    function checkUploadMaxFileSize($min = null, $max = null)
281 282 283 284 285 286 287 288 289 290 291 292 293
    {
        $postMaxSize = ini_get('post_max_size');
        $uploadMaxFileSize = ini_get('upload_max_filesize');
        if ($min !== null) {
            $minCheckResult = $this->compareByteSize($postMaxSize, $min, '>=') && $this->compareByteSize($uploadMaxFileSize, $min, '>=');
        } else {
            $minCheckResult = true;
        }
        if ($max !== null) {
            $maxCheckResult = $this->compareByteSize($postMaxSize, $max, '<=') && $this->compareByteSize($uploadMaxFileSize, $max, '<=');
        } else {
            $maxCheckResult = true;
        }
294

295 296 297 298 299 300 301
        return ($minCheckResult && $maxCheckResult);
    }

    /**
     * Renders a view file.
     * This method includes the view file as a PHP script
     * and captures the display result if required.
302 303 304 305
     * @param string $_viewFile_ view file
     * @param array $_data_ data to be extracted and made available to the view file
     * @param boolean $_return_ whether the rendering result should be returned as a string
     * @return string the rendering result. Null if the rendering result is not required.
306
     */
307
    function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
    {
        // we use special variable names here to avoid conflict when extracting data
        if (is_array($_data_)) {
            extract($_data_, EXTR_PREFIX_SAME, 'data');
        } else {
            $data = $_data_;
        }
        if ($_return_) {
            ob_start();
            ob_implicit_flush(false);
            require($_viewFile_);

            return ob_get_clean();
        } else {
            require($_viewFile_);
        }
    }

    /**
     * Normalizes requirement ensuring it has correct format.
328 329 330
     * @param array $requirement raw requirement.
     * @param integer $requirementKey requirement key in the list.
     * @return array normalized requirement.
331
     */
332
    function normalizeRequirement($requirement, $requirementKey = 0)
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
    {
        if (!is_array($requirement)) {
            $this->usageError('Requirement must be an array!');
        }
        if (!array_key_exists('condition', $requirement)) {
            $this->usageError("Requirement '{$requirementKey}' has no condition!");
        } else {
            $evalPrefix = 'eval:';
            if (is_string($requirement['condition']) && strpos($requirement['condition'], $evalPrefix) === 0) {
                $expression = substr($requirement['condition'], strlen($evalPrefix));
                $requirement['condition'] = $this->evaluateExpression($expression);
            }
        }
        if (!array_key_exists('name', $requirement)) {
            $requirement['name'] = is_numeric($requirementKey) ? 'Requirement #' . $requirementKey : $requirementKey;
        }
        if (!array_key_exists('mandatory', $requirement)) {
            if (array_key_exists('required', $requirement)) {
                $requirement['mandatory'] = $requirement['required'];
            } else {
                $requirement['mandatory'] = false;
            }
        }
        if (!array_key_exists('by', $requirement)) {
            $requirement['by'] = 'Unknown';
        }
        if (!array_key_exists('memo', $requirement)) {
            $requirement['memo'] = '';
        }

        return $requirement;
    }

    /**
     * Displays a usage error.
     * This method will then terminate the execution of the current application.
     * @param string $message the error message
     */
371
    function usageError($message)
372 373 374 375 376 377 378
    {
        echo "Error: $message\n\n";
        exit(1);
    }

    /**
     * Evaluates a PHP expression under the context of this class.
379 380
     * @param string $expression a PHP expression to be evaluated.
     * @return mixed the expression result.
381
     */
382
    function evaluateExpression($expression)
383 384 385 386 387 388 389 390
    {
        return eval('return ' . $expression . ';');
    }

    /**
     * Returns the server information.
     * @return string server information.
     */
391
    function getServerInfo()
392 393 394 395 396 397 398 399 400 401
    {
        $info = isset($_SERVER['SERVER_SOFTWARE']) ? $_SERVER['SERVER_SOFTWARE'] : '';

        return $info;
    }

    /**
     * Returns the now date if possible in string representation.
     * @return string now date.
     */
402
    function getNowDate()
403 404 405 406 407
    {
        $nowDate = @strftime('%Y-%m-%d %H:%M', time());

        return $nowDate;
    }
408
}