phacil-framework/system/system.php

<?php
/**
 * Copyright (c) 2019. ExacTI Technology Solutions
 * GPLv3 General License.
 * https://exacti.com.br
 * Phacil PHP Framework - https://github.com/exacti/phacil-framework
 */

namespace Phacil\Framework;

/**
 * Start engine class
 * 
 * @since 1.0.0
 * @package Phacil\Framework
 * @property \Phacil\Framework\Api\Database $db 
 * @property \Phacil\Framework\Api\Log $log 
 * @property \Phacil\Framework\Config $config 
 */
final class startEngineExacTI {

    /**
     * Storage the PHP version
     * 
     * @var string|false
     */
    public $phpversion;
    //protected $includes;

    /**
     * Loaded paths to autoload. 
     * 
     * @see engine/autoload.php
     * @since 1.3.0
     * @deprecated 2.0.0
     * @var array
     */
    protected $dirs = [];
    
    /**
     * Instance of all engine elements
     * 
     * @var Registry
     * 
     * @since 1.0.0
     */
    public $registry;

    /**
     * 
     * @var \Phacil\Framework\Registry
     */
    //static private $RegistryAlt;

    /**
     * System pre actions loader
     * 
     * @var false|ActionSystem|\Phacil\Framework\Interfaces\Action
     * @since 1.5.1
     */
    private $preActions = false;

    /**
     * Composer object
     * 
     * @var \Composer\Autoload\ClassLoader|false
     */
    private $composer = false;

    /**
     * 
     * @var \Phacil\Framework\startEngineExacTI
     */
    static private $instance;

    /**
     * @return void 
     * @throws Exception 
     * @throws TypeError 
     */
    public function __construct () {

        // Check Version
        $this->phpversion = $this->checkPHPversion();

        //Check Config Load
        $loadConfig = $this->checkConfigFile();

        if($loadConfig) {
            $this->defineAuxConstants();
        }

        if(defined('DEBUG') && DEBUG == true) {
            error_reporting(E_ALL);
            ini_set('display_errors', 1);
        }

        $this->loadengine();

        // Registry
        $this->registry = new Registry();

        //self::$RegistryAlt = &$this->registry;

        $this->request = new Request();

        \Phacil\Framework\Registry::addPreference(\Phacil\Framework\Config::DIR_SYSTEM()."etc/preferences.json");

        \Phacil\Framework\Registry::addPreference(\Phacil\Framework\Config::DIR_APP_MODULAR()."etc/preferences.json");

        \Phacil\Framework\Registry::addPreferenceByRoute(self::getRoute());

        if($this->composer) {
            $this->registry->set('composer', $this->composer);
        }
    }

    static public function getRoute() {
        if (Request::GET('route')) {
            return (Request::GET('route'));
        } else {
            $default = \Phacil\Framework\Config::DEFAULT_ROUTE() ?: \Phacil\Framework\Config::DEFAULT_ROUTE('common/home');
            return Request::GET('route', $default);
        }
        return Request::GET('route') ?: (\Phacil\Framework\Config::DEFAULT_ROUTE() ?: \Phacil\Framework\Config::DEFAULT_ROUTE('common/home'));
    }

    /**
     * 
     * @return \Phacil\Framework\startEngineExacTI 
     */
    static public function getInstance() {
        if(!self::$instance) 
            self::$instance = new self();

        return self::$instance;
    }

    /**
     * @param \Phacil\Framework\startEngineExacTI $instance 
     * @return void 
     */
    static public function setInstance(startEngineExacTI $instance) {
        self::$instance = &$instance;
    }

    /**
     * @param string $key 
     * @return object 
     */
    public function __get($key) {
        return $this->registry->get($key);
    }

    /**
     * @param string $key 
     * @param object $value 
     * @return void 
     */
    public function __set($key, $value) {
        $this->registry->set($key, $value);
    }

    /** 
     * Check if system have a minimum PHP requirement
     * @since 1.0.0
     * @return string|false 
     */
    private function checkPHPversion() {
        if (version_compare(phpversion(), '5.6.20', '>') == false) {
            trigger_error('PHP 5.6.20+ Required', E_USER_ERROR);
            die('PHP 5.6.20+ Required');
        } else {
            return phpversion();
        }
    }

    /**
     * Check if config file is present loadable
     * @return true|void  
     * @since 1.0.0
     */
    private function checkConfigFile() {

        if (!$this->checkConstantsRequired()) {
            try {
                $baseDir = str_replace('system', '', __DIR__);
                include_once($baseDir."config.php");

                if (!$this->checkConstantsRequired()) {
                    throw new \Exception("Can't load minimun config constants, please check your config file!");
                }

            } catch (\Exception $e) {
                exit($e->getMessage());
            }

        } 
        
        return true;
    }

    /** 
     * Check if have the required minimum configurations
     * @return bool  
     * @since 1.0.0
     */
    private function checkConstantsRequired () {
        return !(!defined('DIR_APPLICATION') || !defined('DIR_SYSTEM') || !defined('DIR_PUBLIC') || !defined('DIR_TEMPLATE') || !defined('USE_DB_CONFIG'));
    }

    /** 
     * Define compatibility constants
     * @return void  
     * @since 1.0.0
     */
    private function defineAuxConstants () {
        (defined('HTTP_URL')) ? define('HTTP_SERVER', HTTP_URL) : '';
        (defined('HTTPS_URL')) ? define('HTTPS_SERVER', HTTPS_URL) : '';
    }

    /**
     * Load the autoload SPL engine
     * @return void 
     * @throws Exception 
     * @since 1.0.0
     */
    private function loadengine () {
        require_once (DIR_SYSTEM.'engine/autoload.php');

        if(isset($autoloadComposer)) {
            $this->composer = &$autoloadComposer;
        }
    }

    /**
     * Define the timezone
     * @param string $utc 
     * @return void 
     * @since 1.2.1
     */
    public function setTimezone($utc) {

        try {
            $tzc = @date_default_timezone_set($utc);
            if (!$tzc){
                throw new \Phacil\Framework\Exception\ErrorException($utc. " not found in PHP Compiler.");
            }
        } catch (\ErrorException $e) {
            $trace = ($e->getTrace());

            throw new Exception('Timezone Error: '.  $e->getMessage() ." on ". $trace[0]['file'] ." in line ". $trace[0]['line'].".");
        }

    }

    /** 
     * Get the timezone
     * @since 1.2.1
     * @return string  
     */
    public function getTimezone(){
        return date_default_timezone_get();
    }

    /** 
     * List system available timezones
     * @since 1.2.1
     * @return array|false  
     */
    public function listTimezones() {
        return \DateTimeZone::listIdentifiers(\DateTimeZone::ALL);
    }

    /** 
     * Return Phacil Framework version
     * @since 1.3.1
     * @return string|false  
     */
    public function version() {
        return file_get_contents(\Phacil\Framework\Config::DIR_SYSTEM()."engine/VERSION");
    }

    /** 
     * Include extra registration file
     * @since 1.3.2
     * @return void  
     */
    public function extraRegistrations() {

        if(file_exists(\Phacil\Framework\Config::DIR_SYSTEM()."registrations.php"))
            include(\Phacil\Framework\Config::DIR_SYSTEM()."registrations.php");
    }

    /** 
     * Return the defined constants
     * @return array 
     * @since 1.5.0
     */
    public function constants(){
        return get_defined_constants(true);
    }

    /** 
     * Return only user defined constants
     * @return array  
     * @since 1.5.0
     */
    public function userConstants() {
        return $this->constants()['user'];
    }

    /**
     * Return defined constant based as group
     * @param string $constant 
     * @param string $group 
     * @return mixed 
     * @since 1.5.0
     */
    public function constantName($constant, $group = 'user') {

        foreach ($this->constants()[$group] as $name => $value){
            if($constant === $value)
                return $name;
        }

        return $constant;
    }

    /** 
     * Add controller system pre-actions
     * @return array 
     * @since 1.5.1
     */
    public function controllerPreActions() {
        return (isset($this->preActions) && is_array($this->preActions)) ? $this->preActions : [];
    }

    /**
     * Add route to pre actions array
     * 
     * @param string $route 
     * @return void 
     * @since 2.0.0
     */
    public function addControllerPreAction($route) {
        $this->preActions[] = $route;
        return;
    }

    /**
     * Check the registry element
     * 
     * @since 2.0.0
     * @param string $key 
     * @return true|null 
     */
    public function checkRegistry($key){
        if(isset($this->registry->$key)) return $this->registry->$key;

        switch ($key) {
            case 'mail':
                /** @var \Phacil\Framework\Mail\Api\MailInterface */
                $this->registry->set($key, $this->registry->getInstance(\Phacil\Framework\Mail\Api\MailInterface::class));
                break;
            
            case 'translate':
                $this->registry->set($key, $this->registry->getInstance(\Phacil\Framework\Translate::class));
                break;
            
            case 'session':
                $this->registry->set($key, $this->registry->getInstance(\Phacil\Framework\Session::class));
                break;
            
            case 'document':
                /** @var \Phacil\Framework\Api\Document */
                $this->registry->set($key, $this->registry->getInstance(\Phacil\Framework\Api\Document::class));
                break;
            
            case 'log':
                /** @var \Phacil\Framework\Api\Log */
                $this->registry->set($key, $this->registry->create(\Phacil\Framework\Api\Log::class, [$this->config->get('config_error_filename')]));
                break;
            
            case 'cache':
                /** @var \Phacil\Framework\Caches */
                $this->registry->set($key, $this->registry->getInstance(\Phacil\Framework\Caches::class));
                break;
            
            default:
                $objectToCreate = false;
                break;
        }

        return ($this->registry->has($key)) ? $this->registry->get($key) : null;
    }

    /** @return \Phacil\Framework\Registry  */
    static public function getRegistry() {
        return self::$instance->registry;
    }

    /** @return null|array|string  */
    public function isDeveloperMode() {
        //return $this->config->get('config_developer_mode');
        return \Phacil\Framework\Config::DEBUG() && $this->config->get('config_error_display');
    }

    /**
     * @param \Exception $e 
     * @return never 
     * @throws \ReflectionException 
     * @throws \Exception 
     * @throws \Phacil\Framework\Exception 
     */
    public function terminate(\Exception $e)
    {
        /** @var Response $response */
        $response = $this->registry->create(\Phacil\Framework\Response::class);
        $response->clearHeaders();
        $response->code(500);
        $response->addHeader('Content-Type', 'text/plain');
        $response->setOutput('');
        if ($this->isDeveloperMode()) {
            $response->addHeader('Content-Type', 'text/html');
            
            $response->setParcialOutput(sprintf("<strong>%s</strong>", get_class($e)).PHP_EOL);
            $response->setParcialOutput(sprintf("<pre>%s</pre>", $e->getMessage()) . PHP_EOL);
            //print_r(\Phacil\Framework\Debug::backtrace(true));
            $response->setParcialOutput(\Phacil\Framework\Debug::trace($e->getTrace(), true, true) . PHP_EOL);

            if($e->getPrevious()) {
                $p = $e->getPrevious();
                $response->setParcialOutput(sprintf("<strong>%s</strong>", get_class($p)) . PHP_EOL);
                $response->setParcialOutput(sprintf("<pre>%s</pre>", $p->getMessage()) . PHP_EOL);
                $response->setParcialOutput(\Phacil\Framework\Debug::trace($p->getTrace(), true, true) . PHP_EOL);
            }
        } else {
            $message = "An error has happened during application run. See exception log for details." . PHP_EOL;
            try {
                if (!$this->registry) {
                    throw new \DomainException();
                }
                $this->log->critical($e);
            } catch (\Exception $e) {
                $message .= "Could not write error message to log. Please use developer mode to see the message." . PHP_EOL;
            }
            $response->setOutput($message);
        }
        $response->output();
        exit(1);
    }

}

/** 
 * @var \Phacil\Framework\startEngineExacTI $engine 
 * */
$engine = startEngineExacTI::getInstance();

try {

    // Registry
    /** @var \Phacil\Framework\startEngineExacTI $engine */
    $engine->engine = $engine;

    // Loader
    /**
     * @var \Phacil\Framework\Interfaces\Loader
     */
    $engine->load = $engine->getRegistry()->create(\Phacil\Framework\Interfaces\Loader::class, [$engine->registry]);

    // Config
    /** @var Config */
    $engine->config = $engine->getRegistry()->create(\Phacil\Framework\Config::class);

    // Exception Handler
    set_exception_handler(function ($e) use (&$engine) {
        if ($engine->config->get('config_error_display')) {
            echo '<p><strong>' . get_class($e) . '</strong>: ' . $e->getMessage() . ' in <strong><em>' . str_replace(\Phacil\Framework\Config::DIR_APPLICATION(), '', $e->getFile()) . '</em></strong> on line <strong>' . $e->getLine() . '</strong></p>';
        }

        if (get_class($e) != 'Phacil\Framework\Exception') {
            $exception = new \Phacil\Framework\Exception();
            $exception->setObject($e);
        }


        if ($engine->config->get('config_error_log')) {
            $engine->log->write(get_class($e) . ':  ' . $e->getMessage() . ' in ' . $e->getFile() . ' on line ' . $e->getLine());
        }
    });

    if (\Phacil\Framework\Config::DB_DRIVER())
        $engine->db = $engine->getRegistry()->create(\Phacil\Framework\Api\Database::class, [
            \Phacil\Framework\Config::DB_DRIVER(),
            \Phacil\Framework\Config::DB_HOSTNAME(),
            \Phacil\Framework\Config::DB_USERNAME(),
            \Phacil\Framework\Config::DB_PASSWORD(),
            \Phacil\Framework\Config::DB_DATABASE()
        ]);

    // Settings
    if (!empty($configs)) {
        foreach ($configs as $key => $confValue) {
            $engine->config->set($key, $confValue);
        }
    }

    if (\Phacil\Framework\Config::USE_DB_CONFIG() === true) {

        $query = (\Phacil\Framework\Config::CUSTOM_DB_CONFIG()) ? $engine->db->query(\Phacil\Framework\Config::CUSTOM_DB_CONFIG()) : $engine->db->query()->select()->from('settings')->orderBy('setting_id', \Phacil\Framework\MagiQL\Api\Syntax\OrderBy::ASC)->load();

        foreach ($query as $setting) {
            if (!$setting['serialized']) {
                $engine->config->set($setting['key'], $setting['value']);
            } else {
                $engine->config->set($setting['key'], unserialize($setting['value']));
            }
        }
    }


    $engine->config->set('config_url', \Phacil\Framework\Config::HTTP_URL());
    $engine->config->set('config_ssl', \Phacil\Framework\Config::HTTPS_URL());

    //timezone
    if ($engine->config->get('date_timezone')) {
        $engine->setTimezone($engine->config->get('date_timezone'));
    }

    // Site Title
    if ($engine->config->get('PatternSiteTitle') == true) {
        define('PATTERSITETITLE', $engine->config->get('PatternSiteTitle'));
    } else {
        define('PATTERSITETITLE', false);
    }

    /**
     * Url
     * @var \Phacil\Framework\Interfaces\Url
     */
    $engine->url = $engine->getRegistry()->create(\Phacil\Framework\Interfaces\Url::class, [
        $engine->config->get('config_url'),
        $engine->config->get('config_use_ssl') ? $engine->config->get('config_ssl') : $engine->config->get('config_url')
    ]);

    // Log
    if (!$engine->config->get('config_error_filename')) {
        $engine->config->set('config_error_filename', 'error.log');
    }

    /**
     * @var \Phacil\Framework\Api\Log
     */
    //$engine->log = $engine->getRegistry()->create(\Phacil\Framework\Api\Log::class, [$engine->config->get('config_error_filename')]);

    // Error Handler
    set_error_handler(function ($errno, $errstr, $errfile, $errline) use (&$engine) {
        $showPrepend = false;
        switch ($errno) {
            case E_NOTICE:
            case E_USER_NOTICE:
                $error = 'Notice';
                $logFunction = 'notice';
                break;
            case E_WARNING:
            case E_USER_WARNING:
                $error = 'Warning';
                $logFunction = 'warning';
                break;
            case E_ERROR:
                $error = 'Fatal Error';
                $logFunction = 'critical';
                break;
            case E_USER_ERROR:
                $error = 'Fatal Error';
                $logFunction = 'error';
                break;
            case E_DEPRECATED:
            case E_USER_DEPRECATED:
                $error = 'Deprecated';
                $logFunction = 'warning';
                $showPrepend = true;
                break;
            default:
                $error = $engine->constantName($errno, 'Core');
                $logFunction = 'write';
                $showPrepend = true;
                break;
        }

        if ($engine->config->get('config_error_display')) {
            echo '<p><strong>' . $error . '</strong>: ' . $errstr . ' in <em>' . str_replace(\Phacil\Framework\Config::DIR_APPLICATION(), "", $errfile) . '</em> on line <strong>' . $errline . '</strong></p>';
        }

        if ($engine->config->get('config_error_log')) {
            $engine->log->$logFunction(($showPrepend ?  $error . ':  ' : '') . $errstr . ' in ' . $errfile . ' on line ' . $errline . ' | Phacil ' . $engine->version() . ' on PHP ' . $engine->phpversion);
        }

        return true;
    });

    // Session
    $engine->session = $engine->getRegistry()->create(\Phacil\Framework\Session::class);

    /**
     * Caches
     * @var Caches
     */
    //$engine->cache = new Caches();

    // Response
    /** @var Response */
    $engine->response = $engine->registry->getInstance(\Phacil\Framework\Response::class);
    $engine->response->addHeader('Content-Type', 'text/html; charset=utf-8');

    if ($engine->config->get('config_compression'))
        $engine->response->setCompression($engine->config->get('config_compression'));

    // Custom registrations
    $engine->extraRegistrations();

    // Front Controller
    $frontController = new Front($engine->registry);

    // SEO URL's
    $frontController->addPreAction(new Action((string) 'url/seo_url', [], \Phacil\Framework\Interfaces\Action::SYSTEM));

    //extraPreActions
    if ($engine->controllerPreActions()) {
        foreach ($engine->controllerPreActions() as $action) {
            $frontController->addPreAction(new Action($action));
        }
    }

    // Router
    $action = new Action(startEngineExacTI::getRoute());

    // Dispatch
    $not_found = \Phacil\Framework\Config::NOT_FOUND() ?: \Phacil\Framework\Config::NOT_FOUND('error/not_found');
    $frontController->dispatch($action, ($not_found));

    // Output
    $engine->response->output();
} catch (\Exception $th) {
    $engine->terminate($th);
    //throw new \Exception($th->getMessage(), $th->getCode(), $th);
}