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: 

<?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/>.
 */

use Nethgui\System\PlatformInterface as Validate;

/**
 *
 */
class Menu extends \Nethgui\Controller\AbstractController implements \Nethgui\Component\DependencyConsumer
{

    /**
     *
     * @var string Current menu item identifier
     * @return Menu
     */
    private $currentItem;

    /**
     *
     * @var \Nethgui\Module\ModuleSetInterface
     */
    private $moduleSet;

    public function initialize()
    {
        parent::initialize();
        $this->declareParameter('search', Validate::ANYTHING);
    }

    protected function initializeAttributes(\Nethgui\Module\ModuleAttributesInterface $base)
    {
        $attributes = new SystemModuleAttributesProvider();
        $attributes->initializeFromModule($this);
        return $attributes;
    }    
    
    /**
     *
     * @param \Nethgui\Controller\RequestInterface $originalRequest
     * @return \Nethgui\Module\Menu
     */
    public function setCurrentModuleIdentifier(\Nethgui\Controller\RequestInterface $originalRequest)
    {
        $this->currentItem = \Nethgui\array_head($originalRequest->getPath());
        return $this;
    }

    /**
     *
     * @param \Nethgui\Module\ModuleSetInterface $moduleSet
     * @return Menu
     */
    public function setModuleSet(\Nethgui\Module\ModuleSetInterface $moduleSet)
    {
        $this->moduleSet = $moduleSet;
        return $this;
    }

    private function searchTags(\Nethgui\View\ViewInterface $view, $query)
    {
        if (is_null($this->moduleSet)) {
            return array();
        }

        $translator = $view->getTranslator();
        $results = array();

        foreach ($this->moduleSet as $module) {
            if ( ! $module instanceof \Nethgui\Module\ModuleInterface) {
                continue;
            }

            if ( ! $module->isInitialized()) {
                $module->setPlatform($this->getPlatform());
                $module->initialize();
            }

            $tags = array_map('trim', explode(' ', $module->getAttributesProvider()->getTags()));

            foreach ($tags as $tag) {
                $tagTranslated = $translator->translate($module, $tag);
                if (stripos($tagTranslated, $query) !== FALSE) {
                    $results[] = $view->getModuleUrl('/' . $module->getIdentifier());
                }
            }
        }

        return $results;
    }

    public function prepareView(\Nethgui\View\ViewInterface $view)
    {
        if ($view->getTargetFormat() === $view::TARGET_JSON) {
            if ($this->getRequest()->isEmpty()) {
                return;
            }
            $view['tags'] = $this->searchTags($view, $this->parameters['search']);
            return;
        }

        parent::prepareView($view);
        $view->setTemplate(array($this, 'renderModuleMenu'));

        $categories = array();
        $translator = $view->getTranslator();

        if(defined('NETHGUI_MENU_CATEGORIES')) {
            $categoryOrder = array_flip(array_map('trim', explode(',', NETHGUI_MENU_CATEGORIES)));
        } else {
            $categoryOrder = array();
        }

        foreach ($this->moduleSet as $moduleIdentifier => $moduleInstance) {
            if ( ! $moduleInstance instanceof \Nethgui\Module\ModuleInterface) {
                continue;
            }

            $attributes = $moduleInstance->getAttributesProvider();

            $category = $attributes->getCategory();
            $title = $translator->translate($moduleInstance, $attributes->getTitle());
            $tags = $translator->translate($moduleInstance, $attributes->getTags());
            $description = $translator->translate($moduleInstance, $attributes->getDescription());
            $href = $view->spawnView($moduleInstance)->getModuleUrl();
            $position = $attributes->getMenuPosition();

            // skip elements without any category
            if (is_null($category)) {
                continue;
            }

            // initialize category:
            if ( ! isset($categories[$category])) {
                $categories[$category] = array(
                    'key' => $category,
                    'title' => $translator->translate($moduleInstance, $category),
                    'items' => array()
                );
            }

            // add item to category
            if ( ! isset($categories[$category]['items'][$moduleIdentifier])) {
                $categories[$category]['items'][$moduleIdentifier] = array(
                    'identifier' => $moduleIdentifier,
                    'title' => $title,
                    'description' => $description,
                    'href' => $href,
                    'tags' => $tags,
                    'position' => $position
                );
            }
        }


        foreach ($categories as &$category) {
            usort($category['items'], array($this, 'sortItems'));
        }

        usort($categories, function($c, $d) use ($categoryOrder) {

                if (isset($categoryOrder[$c['key']], $categoryOrder[$d['key']])) {
                    return $categoryOrder[$c['key']] - $categoryOrder[$d['key']];
                }

                return strcmp($c['title'], $d['title']);
            });

        $view['categories'] = $categories;
    }

    public function sortItems($a, $b)
    {
        return strcmp($a['title'], $b['title']);
    }

    public function renderModuleMenu(\Nethgui\Renderer\Xhtml $view)
    {
        $view->includeFile('Nethgui/Js/jquery.nethgui.controller.js');
        $view->includeFile('Nethgui/Js/jquery.nethgui.navigation.js');

        $rootList = $view->elementList()->setAttribute('wrap', '/');
        foreach ($view['categories'] as $category) {
            // Add category title with fake module
            $rootList->insert(
                $view->panel()
                    ->setAttribute('class', 'category')
                    ->insert($view->literal($category['title'])->setAttribute('hsc', TRUE))
            );

            // Add category contents:
            $el = $view->elementList()->setAttribute('class', FALSE);

            foreach ($category['items'] as $item) {
                $el->insert($this->renderMenuItem($view, $item));
            }

            $rootList->insert($el);
        }

        $searchPanel = $view->panel()
            ->setAttribute('class', 'searchPanel ui-corner-all')
            ->insert($view->textInput("search", $view::LABEL_NONE)->setAttribute('placeholder', $view->translate('Search') . "..."))
            ->insert($view->button("Find", $view::BUTTON_SUBMIT)->setAttribute('class', 'Button search'));

        return $view->panel()
                ->setAttribute('class', 'Navigation Flat ' . $view->getClientEventTarget("tags"))
                ->insert($view->form()
                    ->setAttribute('method', 'get')
                    ->insert($searchPanel)
                    ->insert($rootList)
                )
        ;
    }

    protected function renderMenuItem(\Nethgui\Renderer\Xhtml $view, $item)
    {
        $placeholders = array(
            '%HREF' => htmlspecialchars($item['href']),
            '%CONTENT' => htmlspecialchars($item['title']),
            '%TITLE' => htmlspecialchars($item['description']),
        );

        if ($item['identifier'] === $this->currentItem) {
            $tpl = '<a href="%HREF" title="%TITLE" class="currentMenuItem">%CONTENT</a>';
        } else {
            $tpl = '<a href="%HREF" title="%TITLE">%CONTENT</a>';
        }

        return $view->literal(strtr($tpl, $placeholders))->setAttribute('hsc', FALSE);
    }

    public function getDependencySetters()
    {
        return array(
            'OriginalRequest' => array($this, 'setCurrentModuleIdentifier'),
            'ModuleSet' => array($this, 'setModuleSet'),
        );
    }
}