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: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 

<?php

namespace Nethgui\View;

/*
 * 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 view object holds output data and references to child views.
 * 
 * It inherits an ArrayAccess interface and is capable to convert its internal
 * state to a string using a Template.
 *
 * A Template can be a PHP script or a callback function that receives the
 * view state.
 *
 * Usually, PHP templates are kept into View/ directories, but generally they
 * follow the class naming convention.
 *
 * Moreover, every module has a View object assigned to it as a parameter during
 * prepareView() operation.
 *
 * @author Davide Principi <davide.principi@nethesis.it>
 * @see \Nethgui\Module\ModuleInterface::prepareView()
 * @since 1.0

 */
class View implements \Nethgui\View\ViewInterface, \Nethgui\Log\LogConsumerInterface, \Nethgui\View\CommandReceiverInterface
{
    /**
     * Reference to associated module
     * @var \Nethgui\Module\ModuleInterface
     */
    private $module;

    /**
     * Holds view state
     * @var array
     */
    private $data;

    /**
     *
     * @var string
     */
    private $template;

    /**
     * Caches the identifier of all ancestors from the root to the
     * associated $module.
     * @var array
     */
    private $modulePath;

    /**
     *
     * @var \Nethgui\View\TranslatorInterface;
     */
    private $translator;

    /**
     * An array of two or more strings 
     * 
     * Index 0 => Site URL without trailing slash (Schema, Host, Port)
     * Index 1 => URL path (without controller)
     * Index 2 => [Optional] controller path (example index.php/)
     * 
     * @var array
     */
    private $urlParts;

    /**
     * Provided for backward compatibility
     * @deprecated since 1.6
     * @var \Nethgui\View\LegacyCommandBag
     */
    public $commands;

    /**
     *
     * @var string
     */
    private $targetFormat;

    /**
     *
     * @param string $targetFormat The target format file extension of the final view output
     * @param \Nethgui\Module\ModuleInterface $module
     * @param \Nethgui\View\TranslatorInterface $translator
     * @param array $urlParts An array of three strings corresponding to <siteUrl, pathUrl, controllerPath>
     */
    public function __construct($targetFormat, \Nethgui\Module\ModuleInterface $module, \Nethgui\View\TranslatorInterface $translator, $urlParts = array())
    {
        $this->module = $module;
        $this->translator = $translator;
        $this->urlParts = $urlParts;
        $this->template = str_replace('\Module\\', '\Template\\', get_class($module));
        $this->data = array();
        $this->targetFormat = $targetFormat;
    }

    public function getTargetFormat()
    {
        $this->getLog()->deprecated();
        return $this->targetFormat;
    }

    public function copyFrom($data)
    {
        foreach ($data as $offset => $value) {
            $this->offsetSet($offset, $value);
        }
        return $this;
    }

    public function setTemplate($template)
    {
        $this->template = $template;
        return $this;
    }

    public function getTemplate()
    {
        return $this->template;
    }

    public function spawnView(\Nethgui\Module\ModuleInterface $module, $register = FALSE)
    {
        $spawnedView = new static($this->targetFormat, $module, $this->translator, $this->urlParts);
        $spawnedView->commands = $this->getCommands();
        if ($register === TRUE) {
            $this[$module->getIdentifier()] = $spawnedView;
        } elseif (is_string($register)) {
            $this[$register] = $spawnedView;
        }
        return $spawnedView;
    }

    public function getIterator()
    {
        return new \ArrayIterator($this->data);
    }

    public function offsetExists($offset)
    {
        return array_key_exists($offset, $this->data);
    }

    public function offsetGet($offset)
    {
        if ($this->offsetExists($offset)) {
            return $this->data[$offset];
        }

        return NULL;
    }

    public function offsetSet($offset, $value)
    {
        if (is_null($offset)) {
            $this->data[] = $value;
        } else {
            $this->data[$offset] = $value;
        }
    }

    public function offsetUnset($offset)
    {
        unset($this->data[$offset]);
    }

    public function translate($value, $args = array())
    {
        return $this->translator->translate($this->getModule(), $value, $args);
    }

    public function getTranslator()
    {
        return $this->translator;
    }

    public function getModule()
    {
        return $this->module;
    }

    public function getModulePath()
    {
        if ( ! isset($this->modulePath)) {
            $this->modulePath = array();

            $watchdog = 0;
            $module = $this->getModule();

            while ( ! (is_null($module))) {
                if (++ $watchdog > 20) {
                    throw new \LogicException(sprintf("%s: Too many nested modules or cyclic module structure.", get_class($this)), 1322150445);
                }

                $moduleIdentifier = $module->getIdentifier();
                if (strlen($moduleIdentifier) > 0) {
                    array_unshift($this->modulePath, $moduleIdentifier);
                }
                $module = $module->getParent();
            }
        }

        return $this->modulePath;
    }

    public function resolvePath($path)
    {
        if (is_array($path) || is_object($path)) {
            throw new \InvalidArgumentException(sprintf('%s: $path argument must be a string, `%s` given.', get_class($this), gettype($path)), 1322150499);
        }

        $path = strval($path);

        if (strlen($path) > 0 && $path[0] == '/') {
            // if the first character is a / consider an absolute path
            $pathSegments = array();
        } else {
            // else consider a path relative to the current module
            $pathSegments = $this->getModulePath();
        }

        foreach (explode('/', $path) as $part) {
            if ($part === '' || $part === '.') {
                continue; // skip empty parts
            } elseif ($part == '..') {
                array_pop($pathSegments); // backreference
            } else {
                $pathSegments[] = $part; // add segment
            }
        }

        return $pathSegments;
    }

    public function getUniqueId($path = '')
    {
        return implode('_', $this->resolvePath($path));
    }

    public function getClientEventTarget($name)
    {
        if (NETHGUI_ENABLE_TARGET_HASH === FALSE) {
            return 'T_' . $this->getUniqueId($name);
        }
        return 'T' . substr(md5($this->getUniqueId($name)), 0, 8);
    }

    /**
     * @param string $path
     * @param array $parameters
     */
    private function buildModuleUrl($path, $parameters = array())
    {
        if (is_array($path) || is_object($path)) {
            throw new \InvalidArgumentException(sprintf('%s: $path argument must be a string, `%s` given.', get_class($this), gettype($path)), 1322150500);
        }

        $path = strval($path);
        $fragment = '';

        if (strpos($path, '#') !== FALSE) {
            list($path, $fragment) = explode('#', $path, 2);
            $fragment = '#' . $fragment;
        }

        $segments = $this->resolvePath($path);

        $url = implode('', \Nethgui\array_rest($this->urlParts)) . implode('/', $segments);

        if ( ! empty($parameters)) {
            $url .= '?' . http_build_query($parameters);
        }

        return $url . $fragment;
    }

    public function getModuleUrl($path = '')
    {
        return $this->buildModuleUrl($path);
    }

    public function getSiteUrl()
    {
        return $this->urlParts[0];
    }

    public function getPathUrl()
    {
        return $this->urlParts[1];
    }

    public function setLog(\Nethgui\Log\LogInterface $log)
    {
        $this->log = $log;
        return $this;
    }

    public function getLog()
    {
        if (isset($this->log)) {
            return $this->log;
        } elseif ($this->getModule() instanceof \Nethgui\Log\LogConsumerInterface) {
            return $this->getModule()->getLog();
        } elseif ($this->translator instanceof \Nethgui\Log\LogConsumerInterface) {
            return $this->translator->getLog();
        } else {
            return new \Nethgui\Log\Nullog();
        }
    }

    public function executeCommand(\Nethgui\View\ViewInterface $origin, $selector, $name, $arguments)
    {
        $this->getLog()->deprecated(sprintf("%%s %%s: %s() command is DEPRECATED", __CLASS__, $name));
        $module = $this->getModule();
        if ($module instanceof \Nethgui\View\CommandReceiverInterface) {
            $module->executeCommand($origin, $selector, $name, $arguments);
        }
    }

    public function getCommandList($selector = '')
    {
        $this->getLog()->deprecated();
        $this->getCommands()->setContext($this, $selector);
        return $this->getCommands();
    }

    public function hasCommandList($selector = '')
    {
        $this->getLog()->deprecated();
        return FALSE;
    }

    public function getCommands()
    {
        $this->getLog()->deprecated();
        return $this->commands;
    }

    /**
     * Remove all enqueued commands without executing them
     * 
     * @return View
     */
    public function clearAllCommands()
    {
        $this->getCommands()->exchangeArray(array());
        return $this;
    }

}