AppserverIo\Appserver\Core\DgClassLoader

Complexity

Total Complexity

44

Size/Duplication

Total Lines	369
Duplicated Lines	0 %

Test Coverage

Coverage

4.42%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
B	createDefinitions()	0	60	8
A	getAspectRegister()	0	3	1
A	loadClassProductionNoOmit()	0	10	2
A	fillCache()	0	4	1
A	getStructureMap()	0	3	1
A	getConfig()	0	3	1
A	init()	0	22	2
A	createCache()	0	12	4
A	getCacheDir()	0	3	1
B	loadClass()	0	34	11
A	__construct()	0	9	1
A	injectAspectRegister()	0	3	1
A	refillCache()	0	13	4
A	register()	0	15	3
A	unregister()	0	12	3

<?php

/**
 * \AppserverIo\Appserver\Core\DgClassLoader
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Bernhard Wick <bw@appserver.io>
 * @copyright 2015 TechDivision GmbH - <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/appserver
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Appserver\Core;

use AppserverIo\Doppelgaenger\Config;
use AppserverIo\Doppelgaenger\CacheMap;
use AppserverIo\Doppelgaenger\Generator;
use AppserverIo\Doppelgaenger\AspectRegister;
use AppserverIo\Doppelgaenger\Entities\Definitions\Structure;
use AppserverIo\Appserver\Core\Interfaces\ClassLoaderInterface;

/**
 * This class is used to delegate to doppelgaenger's autoloader. This is needed as our
 * multi-threaded environment would not allow any out-of-the-box code generation in an
 * on-the-fly manner.
 *
 * @author    Bernhard Wick <bw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/appserver
 * @link      http://www.appserver.io
 *
 * @property \AppserverIo\Doppelgaenger\AspectRegister         $aspectRegister Register for all aspects which have to be taken into account
 * @property boolean                                           $autoloaderOmit Whether or not certain namespaces get omitted
 * @property string                                            $cacheDir       Directory where cached definitions reside
 * @property boolean                                           $cacheIsReady   Whether or not the cache is ready for usage
 * @property \AppserverIo\Doppelgaenger\Config                 $config         THe configuration for this classloader
 * @property string                                            $environment    Environment, either 'production' or 'development'
 * @property \AppserverIo\Appserver\Core\StackableStructureMap $structureMap   Map which holds all known structures
 */
class DgClassLoader extends \Stackable implements ClassLoaderInterface
{

    /**
     * The amount of structures we will generate per thread
     *
     * @const int GENERATOR_STACK_COUNT
     */
    const GENERATOR_STACK_COUNT = 5;

    /**
     * The unique class loader identifier.
     *
     * @var string
     */
    const IDENTIFIER = 'doppelgaenger';

    /**
     * The name of our autoload method.
     *
     * @const string OUR_LOADER
     */
    const OUR_LOADER = 'loadClass';

    /**
     * The name of our simple/quick autoload method.
     *
     * @const string OUR_LOADER_PROD_NO_OMIT
     */
    const OUR_LOADER_PROD_NO_OMIT = 'loadClassProductionNoOmit';

    /**
     * Default constructor
     *
     * We will do all the necessary work to load without any further hassle.
     * Will check if there is content in the cache directory.
     * If not we will parse anew.
     *
     * @param \AppserverIo\Doppelgaenger\Config|null $config An already existing config instance
     */
    public function __construct(Config $config)
    {

        // set the configuration
        $this->config = $config;

        // initialize the variables
        $this->cacheIsReady = false;
        $this->autoloaderOmit = false;
    }

    /**
     * Initializes the autoloader with the values from the configuration
     * and creates and fills the structure map instance.
     *
     * @param \AppserverIo\Appserver\Core\StackableStructureMap $structureMap   Structure map to be used
     * @param \AppserverIo\Doppelgaenger\AspectRegister         $aspectRegister The register for all found aspects
     *
     * @return void
     */
    public function init(StackableStructureMap $structureMap, AspectRegister $aspectRegister)
    {

        // collect the passed instances
        $this->structureMap = $structureMap;
        $this->aspectRegister = $aspectRegister;

        // load the configuration
        $config = $this->getConfig();

        // pre-load the configuration values
        $this->cacheDir =  $config->getValue('cache/dir');
        $this->environment = $config->getValue('environment');

        // we want to know if there are namespaces to be omitted from autoloading
        if ($config->hasValue('autoloader/omit')) {
            $autoloadingOmitted = $config->getValue('autoloader/omit');
            $this->autoloaderOmit = !empty($autoloadingOmitted);
        }

        // we now have a structure map instance, so fill it initially
        $this->getStructureMap()->fill();
    }



    /**
     * Returns the cache directory.
     *
     * @return string The cache directory
     */
    public function getCacheDir()
    {
        return $this->cacheDir;
    }

    /**
     * Will start the generation of the cache based on the known structures
     *
     * @return null
     */
    public function createCache()
    {
        // Check if there are files in the cache.
        // If not we will fill the cache, if there are we will check if there have been any changes to the enforced dirs
        $fileIterator = new \FilesystemIterator($this->getConfig()->getValue('cache/dir'), \FilesystemIterator::SKIP_DOTS);
        if (iterator_count($fileIterator) <= 1 || $this->getConfig()->getValue('environment') === 'development') {
            // Fill the cache
            $this->fillCache();

        } else {
            if (!$this->structureMap->isRecent()) {
                $this->refillCache();
            }
        }
    }

    /**
     * Creates the definitions by given structure map
     *
     * @return bool
     */
    protected function createDefinitions()
    {
        // Get all the structures we found
        $structures = $this->structureMap->getEntries();

        // We will need a CacheMap instance which we can pass to the generator
        // We need the caching configuration
        $cacheMap = new CacheMap($this->getConfig()->getValue('cache/dir'), array(), $this->getConfig());

        // We need a generator so we can create our proxies initially
        $generator = new Generator($this->structureMap, $cacheMap, $this->getConfig(), $this->getAspectRegister());

        // Iterate over all found structures and generate their proxies, but ignore the ones with omitted
        // namespaces
        $omittedNamespaces = array();
        if ($this->getConfig()->hasValue('autoloader/omit')) {
            $omittedNamespaces = $this->getConfig()->getValue('autoloader/omit');
        }

        // Now check which structures we have to create and split them up for multi-threaded creation
        $generatorStack = array();
        /** @var \AppserverIo\Doppelgaenger\Entities\Definitions\Structure $structure */
        foreach ($structures as $identifier => $structure) {
            // Working on our own files has very weird side effects, so don't do it
            if (strpos($structure->getIdentifier(), 'AppserverIo\Doppelgaenger') !== false) {
                continue;
            }

            // Might this be an omitted structure after all?
            foreach ($omittedNamespaces as $omittedNamespace) {
                // If our class name begins with the omitted part e.g. it's namespace
                if (strpos($structure->getIdentifier(), $omittedNamespace) === 0) {
                    continue 2;
                }
            }

            // adding all structures to the generator stack as we cannot assure cross references from aspects here
            $generatorStack[$identifier] = $structure;
        }

        // Chuck the stack and start generating
        $generatorStack = array_chunk($generatorStack, self::GENERATOR_STACK_COUNT, true);

        // Generate all the structures!
        $generatorThreads = array();
        foreach ($generatorStack as $key => $generatorStackChunk) {
            $generatorThreads[$key] = new GeneratorThread($generator, $generatorStackChunk);
            $generatorThreads[$key]->start();
        }

        // Wait on the threads
        foreach ($generatorThreads as $generatorThread) {
            $generatorThread->join();
        }

        // mark this instance as production ready cachewise
        $this->cacheIsReady = true;

        // Still here? Sounds about right
        return true;
    }

    /**
     * Will initiate the creation of a structure map and the parsing process of all found structures
     *
     * @return bool
     */
    protected function fillCache()
    {
        // Lets create the definitions
        return $this->createDefinitions();
    }

    /**
     * Getter for the $aspectRegister property
     *
     * @return \AppserverIo\Doppelgaenger\AspectRegister
     */
    public function getAspectRegister()
    {
        return $this->aspectRegister;
    }

    /**
     * Getter for the config member
     *
     * @return \AppserverIo\Doppelgaenger\Config
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Getter for the structureMap member
     *
     * @return \AppserverIo\Doppelgaenger\StructureMap
     */
    public function getStructureMap()
    {
        return $this->structureMap;
    }

    /**
     * Will inject an AspectRegister instance into the generator
     *
     * @param \AppserverIo\Doppelgaenger\AspectRegister $aspectRegister The AspectRegister instance to inject
     *
     * @return null
     */
    public function injectAspectRegister(AspectRegister $aspectRegister)
    {
        $this->aspectRegister = $aspectRegister;
    }

    /**
     * Will load any given structure based on it's availability in our structure map which depends on the configured
     * project directories.
     *
     * If the structure cannot be found we will redirect to the composer autoloader which we registered as a fallback
     *
     * @param string $className The name of the structure we will try to load
     *
     * @return null
     */
    public function loadClassProductionNoOmit($className)
    {

        // prepare the cache path
        $cachePath = $this->cacheDir . DIRECTORY_SEPARATOR . str_replace('\\', '_', $className) . '.php';

        // check if the file is readable
        if (is_readable($cachePath)) {
            require $cachePath;
            return;
        }
    }

    /**
     * Will load any given structure based on it's availability in our structure map which depends on the configured
     * project directories.
     *
     * If the structure cannot be found we will redirect to the composer autoloader which we registered as a fallback
     *
     * @param string $className The name of the structure we will try to load
     *
     * @return null
     */
    public function loadClass($className)
    {

        // might the class be a omitted one? If so we can require the original.
        if ($this->autoloaderOmit) {
            $omittedNamespaces = $this->config->getValue('autoloader/omit');
            foreach ($omittedNamespaces as $omitted) {
                // If our class name begins with the omitted part e.g. it's namespace
                if (strpos($className, str_replace('\\\\', '\\', $omitted)) === 0) {
                    return;
                }
            }
        }

        // do we have the file in our cache dir? If we are in development mode we have to ignore this.
        if ($this->environment !== 'development') {
            $this->loadClassProductionNoOmit($className);
            if (class_exists($className, false) || interface_exists($className, false) || trait_exists($className, false)) {
                return true;

The expression return true returns the type true which is incompatible with the documented return type null.

            }
        }

        // if we are loading something of our own library we can skip to composer
        if (strpos($className, 'AppserverIo\Doppelgaenger') === 0 || strpos($className, 'AppserverIo\Appserver\Core\StackableStructureMap') !== false) {
            return;
        }

        // get the file from the map
        $file = $this->structureMap->getEntry($className);

        // did we get something? If so we have to load it
        if ($file instanceof Structure) {
            require $file->getPath();
            return true;

The expression return true returns the type true which is incompatible with the documented return type null.

        }
    }

    /**
     * We will refill the cache dir by emptying it and filling it again
     *
     * @return bool
     */
    protected function refillCache()
    {

        // lets clear the cache so we can fill it anew
        foreach (new \DirectoryIterator($this->getConfig()->getValue('cache/dir')) as $fileInfo) {
            if (!$fileInfo->isDot() && !$fileInfo->isDir()) {
                // unlink the file
                unlink($fileInfo->getPathname());
            }
        }

        // lets create the definitions anew
        return $this->createDefinitions();
    }

    /**
     * Will register our autoloading method at the beginning of the spl autoloader stack
     *
     * @param boolean $throw   Should we throw an exception on error?
     * @param boolean $prepend If you want to NOT prepend you might, but you should not
     *
     * @return null
     */
    public function register($throw = true, $prepend = true)
    {

        // now we have a config no matter what, we can store any instance we might need
        $this->getConfig()->storeInstances();

        // query whether the cache is ready or if we aren't in production mode
        if (!$this->cacheIsReady || $this->environment !== 'production') {
            // If yes, load the appropriate autoloader method
            spl_autoload_register(array($this, self::OUR_LOADER), $throw, $prepend);
            return;
        }

        // the cache is ready, so register the simple class loader
        spl_autoload_register(array($this, self::OUR_LOADER_PROD_NO_OMIT), $throw, $prepend);
    }

    /**
     * Uninstalls this class loader from the SPL autoloader stack.
     *
     * @return void
     */
    public function unregister()
    {

        // query whether the cache is ready or if we aren't in production mode
        if (!$this->cacheIsReady || $this->environment !== 'production') {
            // If yes, unload the appropriate autoloader method
            spl_autoload_unregister(array($this, self::OUR_LOADER));
            return;
        }

        // the cache has been ready, so unregister the simple class loader
        spl_autoload_unregister(array($this, self::OUR_LOADER_PROD_NO_OMIT));
    }
}