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: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 

<?php

namespace Nethgui\Module;

/*
 * Copyright (C) 2011 Nethesis S.r.l.
 * 
 * This script is part of NethServer.
 * 
 * NethServer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NethServer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NethServer.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * A composition of modules forwards request handling to its parts.
 * 
 * Inheriting classes must define the composition behaviour.
 * 
 * @author Davide Principi <davide.principi@nethesis.it>
 * @since 1.0
 * @api
 * @see Controller
 * @see List
 */
abstract class Composite extends \Nethgui\Module\AbstractModule implements \Nethgui\Module\ModuleCompositeInterface, \Nethgui\Component\DependencyInjectorAggregate
{
    private $children = array();

    /**
     *
     * @var ModuleLoader
     */
    private $childLoader;

    /**
     *
     * @var callable
     */
    protected $dependencyInjector;

    /**
     * Propagates initialize() message to children.
     *
     * @api
     * @see loadChildren()
     */
    public function initialize()
    {
        parent::initialize();
        foreach ($this->children as $child) {
            if ( ! $child->isInitialized()) {
                call_user_func($this->dependencyInjector, $child);
                $child->initialize();
            }
        }
    }

    /**
     * Adds a child to Composite, initializing it, if current Composite is
     * initialized.
     *
     * @api
     * @param \Nethgui\Module\ModuleInterface $childModule
     * @return Composite
     */
    public function addChild(\Nethgui\Module\ModuleInterface $childModule)
    {
        if (isset($this->children[$childModule->getIdentifier()])) {
            throw new \LogicException(sprintf('%s: the module identifier "%s" is already registered as child!', __CLASS__, $childModule->getIdentifier()), 1322818691);
        }

        $this->children[$childModule->getIdentifier()] = $childModule;

        $childModule->setParent($this);

        if ($this->isInitialized() && ! $childModule->isInitialized()) {
            call_user_func($this->dependencyInjector, $childModule);
            $childModule->initialize();
        }
        return $this;
    }

    /**
     * Get the parts of this Composite.
     *
     * @api
     * @return array
     */
    public function getChildren()
    {
        // TODO: authorize access request on policy decision point.
        return array_values($this->children);
    }

    public function setPlatform(\Nethgui\System\PlatformInterface $platform)
    {
        parent::setPlatform($platform);
        foreach ($this->getChildren() as $childModule) {
            $childModule->setPlatform($platform);
        }
        return $this;
    }

    /**
     * Instantiates the given classes, adding the created objects as children of
     * the composite module.
     *
     * If the first character is `*` (asterisk), the container class name
     * is prepended.
     *
     * @see addChild()
     * @link http://redmine.nethesis.it/issues/196
     * @param type $classList
     * @return \Nethgui\Module\Composite
     * @deprecated since 1.6
     */
    protected function loadChildren($classList)
    {
        $this->getLog()->deprecated();
        foreach ($classList as $item) {
            if ( ! is_string($item)) {
                throw new \InvalidArgumentException(sprintf('%s: $classList elements must be of type String', get_class($this)), 1322148900);
            }

            if (substr($item, 0, 2) === '*\\') {
                $childModuleClass = get_class($this) . '\\' . substr($item, 2);
            } else {
                $childModuleClass = $item;
            }

            $childModule = new $childModuleClass();
            $this->addChild($childModule);
        }
    }

    /**
     * Search all php files under the "children" directory and instantiates
     * any class implementing ModuleInterface.
     * 
     * The "children" directory has the dirname() of $module php source file,
     * and by default its name is the basename() of $module php source file 
     * without .php extension.  You can specify an alternate children directory
     * name in $childrenDir parameter.
     * 
     * @param \Nethgui\Module\ModuleInterface $module Optional the reference module, $this by default
     * @param string $path Optional the children directory name, same as $module php source file by default
     * @return \Nethgui\Module\Composite 
     */
    public function loadChildrenDirectory(\Nethgui\Module\ModuleInterface $module = NULL, $childrenDir = NULL)
    {
        if ( ! isset($this->childLoader)) {
            $this->initChildLoader(is_null($module) ? $this : $module, $childrenDir);
        }

        foreach ($this->childLoader as $childInstance) {
            $this->addChild($childInstance);
        }

        return $this;
    }

    private function initChildLoader(\Nethgui\Module\ModuleInterface $module = NULL, $childrenDir = NULL)
    {
        $ref = new \ReflectionClass($module);
        $filePath = $ref->getFileName();
        if ($filePath === FALSE) {
            throw new \UnexpectedValueException(sprintf('%s: cannot find the file where `%s` is declared', __CLASS__, get_class($module)), 1331035353);
        }
        if (strstr($childrenDir, '.') !== FALSE) {
            throw new \DomainException(sprintf('%s: $childrenDir parameter value must not contain dots', __CLASS__), 1336125731);
        }

        if (is_null($childrenDir)) {
            $childrenDir = basename($filePath, '.php');
        }

        $nsRootPath = realpath(substr($filePath, 0, strlen($filePath) - strlen(get_class($module) . '.php')));

        // remove the last namespace segment and replace with $childrenDir
        $nsPrefixParts = array_slice(explode('\\', get_class($module)), 0, -1);
        $nsParts = array_merge($nsPrefixParts, explode('/', $childrenDir));
        $nsPrefix = implode('\\', $nsParts);

        $this->childLoader = new \Nethgui\Module\ModuleLoader($this->dependencyInjector);
        $this->childLoader
            ->setLog($this->getLog())
            ->setNamespace($nsPrefix, $nsRootPath);
    }

    /**
     * Sort children applying the given callback function
     *
     * @see http://php.net/manual/en/function.usort.php
     * @param callable $callback
     * @return void;
     */
    protected function sortChildren($callback)
    {
        if ( ! is_callable($callback)) {
            throw new \InvalidArgumentException(sprintf('%s: invalid callback for %s#%s()', get_class($this), __CLASS__, __FUNCTION__), 1325760755);
        }

        usort($this->children, $callback);
    }

    public function setLog(\Nethgui\Log\LogInterface $log)
    {
        if (isset($this->childLoader)) {
            $this->childLoader->setLog($log);
        }
        return parent::setLog($log);
    }

    public function setPolicyDecisionPoint(\Nethgui\Authorization\PolicyDecisionPointInterface $pdp)
    {
        parent::setPolicyDecisionPoint($pdp);
        foreach ($this->getChildren() as $child) {
            if ($child instanceof \Nethgui\Authorization\PolicyDecisionPointInterface) {
                $child->setPolicyDecisionPoint($this->getPolicyDecisionPoint());
            }
        }
    }

    public function setDependencyInjector($di)
    {
        $this->dependencyInjector = $di;
        return $this;
    }

}