File Core/src/Utility/System.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2016 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\Core\Utility;

use Cake\Core\Configure;
use Cake\Core\Plugin;

/**
 * Retrieve system information on service availability and general status
 *
 * Provides static methods to get information in array format
 */
class System
{
    /**
     * Get status information
     *
     * @return array Information on environment and datasource/cache connections
     */
    public static function status()
    {
        $env = 'ok';
        $errors = [];
        $check = static::checkPHP();
        if (!$check['success']) {
            $env = 'error';
            $errors['php'] = $check['messages'];
        }

        $check = static::checkFS();
        if (!$check['success']) {
            $env = 'error';
            $errors['fs'] = $check['messages'];
        }

        $check = Database::connectionTest();
        if (!$check['success']) {
            $env = 'error';
            $errors['db'] = $check['error'];
        }

        $res = ['environment' => $env];
        if (Configure::read('debug')) {
            $res['errors'] = $errors;
            $res['debug'] = true;
            $res['plugins'] = Plugin::loaded();
            $res['versions']['BEdita'] = Configure::read('BEdita.version');
        }

        return $res;
    }

    /**
     * Check PHP version and extensions
     *
     * @return array Details of performed check with keys
     *   - 'success' true if check ok, false otherwise
     *   - 'message' array of error messages
     */
    public static function checkPHP()
    {
        $success = true;
        $messages = [];
        static::loadRequirements();
        $required = Configure::read('Requirements');
        if (!version_compare(PHP_VERSION, $required['phpMin'], '>=')) {
            $success = false;
            $messages[] = 'PHP version ' . PHP_VERSION . ' too low, min required ' . $required['phpMin'];
        }

        foreach ($required['extensions'] as $ext) {
            if (!extension_loaded($ext)) {
                $success = false;
                $messages[] = 'Missing PHP extension ' . $ext;
            }
        }

        return compact('success', 'messages');
    }

    /**
     * Check Filesystem
     *
     * @return array Details of performed check with keys
     *   - 'success' true if check ok, false otherwise
     *   - 'message' array of error messages
     */
    public static function checkFS()
    {
        $success = true;
        $messages = [];
        static::loadRequirements();

        foreach (Configure::read('Requirements.writable') as $wr) {
            if (!is_writable($wr)) {
                $success = false;
                $messages[] = 'Directory ' . $wr . ' MUST be writable';
            }
        }

        return compact('success', 'messages');
    }

    /**
     * Load system requirements in Configuration 'Requirements'
     *
     * @return void
     */
    protected static function loadRequirements()
    {
        if (!Configure::read('Requirements')) {
            Configure::load('BEdita/Core.requirements');
        }
    }
}

Namespaces

Classes

Interfaces