BootService.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Di\InternalContainer;
use Elgg\Exceptions\RuntimeException;
use Elgg\Traits\Cacheable;
use Elgg\Traits\Debug\Profilable;
use Psr\Log\LogLevel;

class BootService {

    use Profilable;
    use Cacheable;

    public function __construct(\ElggCache $cache) {
        $this->cache = $cache;
    }

    public function boot(InternalContainer $services) {
        $config = $services->config;

        // we were using NOTICE temporarily so we can't just check for null
        if (!$config->hasInitialValue('debug') && !$config->debug) {
            $config->debug = '';
        }

        // copy all table values into config
        foreach ($services->configTable->getAll() as $name => $value) {
            $config->$name = $value;
        }
        
        // prevent some data showing up in $config
        foreach ($config::SENSITIVE_PROPERTIES as $name) {
            unset($config->{$name});
        }

        // early config is done, now get the core boot data
        $data = $this->getBootData($config, $services->db, $config->hasValue('installed'));

        $site = $data->getSite();
        if ($site) {
            $config->site = $site;
        } else {
            // must be set in config
            $site = $config->site;
            if (!$site instanceof \ElggSite) {
                throw new RuntimeException('Before installation, config->site must have an unsaved ElggSite.');
            }
        }

        $config->sitename = $site->name; // deprecated
        $config->sitedescription = $site->description; // deprecated

        foreach ($data->getPluginSettings() as $guid => $entity_settings) {
            $services->privateSettingsCache->save($guid, $entity_settings);
        }

        foreach ($data->getPluginMetadata() as $guid => $metadata) {
            $services->dataCache->metadata->save($guid, $metadata);
        }

        $services->plugins->setBootPlugins($data->getActivePlugins(), false);

        // use value in settings.php if available
        $debug = $config->getInitialValue('debug') ?? ($config->debug ?: LogLevel::CRITICAL);
        $services->logger->setLevel($debug);

        if ($config->system_cache_enabled) {
            $config->system_cache_loaded = $services->views->configureFromCache($services->serverCache);
        }
    }

    public function clearCache() {
        $this->cache->clear();
        _elgg_services()->plugins->setBootPlugins(null);
        _elgg_services()->config->system_cache_loaded = false;
        _elgg_services()->config->_boot_cache_hit = false;
    }

    private function getBootData(Config $config, Database $db, $installed) {
        $this->beginTimer([__METHOD__]);
        
        $config->_boot_cache_hit = false;

        $data = null;
        if ($config->boot_cache_ttl > 0) {
            $data = $this->cache->load('boot_data');
        }

        if (!isset($data)) {
            $data = new BootData();
            $data->populate($config, $db, _elgg_services()->entityTable, _elgg_services()->plugins, $installed);
            if ($config->boot_cache_ttl && $installed) {
                $this->cache->save('boot_data', $data, $config->boot_cache_ttl);
            }
        } else {
            $config->_boot_cache_hit = true;
        }

        $this->endTimer([__METHOD__]);
        
        return $data;
    }
}