From 8aacc17dd39c94bacf49883c4edc46cba8cc0870 Mon Sep 17 00:00:00 2001
From: Alexander Ebert <ebert@woltlab.com>
Date: Wed, 23 Mar 2016 18:29:41 +0100
Subject: [PATCH] Added proper marking as active for menus

---
 com.woltlab.wcf/templates/__menu.tpl          |  2 +-
 .../lib/data/menu/item/MenuItem.class.php     |  3 +-
 .../lib/data/menu/item/MenuItemNode.class.php | 27 +++++++
 .../data/menu/item/MenuItemNodeTree.class.php | 36 +++++++++
 .../files/lib/data/page/PageCache.class.php   | 71 ++++++++++++++++
 .../lib/system/SingletonFactory.class.php     |  4 +-
 .../cache/builder/PageCacheBuilder.class.php  | 38 +++++++++
 .../system/page/PageLocationManager.class.php | 81 +++++++++++++++++++
 8 files changed, 258 insertions(+), 4 deletions(-)
 create mode 100644 wcfsetup/install/files/lib/data/page/PageCache.class.php
 create mode 100644 wcfsetup/install/files/lib/system/cache/builder/PageCacheBuilder.class.php
 create mode 100644 wcfsetup/install/files/lib/system/page/PageLocationManager.class.php

diff --git a/com.woltlab.wcf/templates/__menu.tpl b/com.woltlab.wcf/templates/__menu.tpl
index a794c46213..ceaa11660b 100644
--- a/com.woltlab.wcf/templates/__menu.tpl
+++ b/com.woltlab.wcf/templates/__menu.tpl
@@ -1,7 +1,7 @@
 <nav>
 	<ol class="boxMenu">
 		{foreach from=$menuItemNodeList item=menuItemNode}
-			<li{if $menuItemNode->hasChildren()} class="boxMenuHasChildren"{/if}>
+			<li class="{if $menuItemNode->isActiveNode()}active{/if}{if $menuItemNode->hasChildren()} boxMenuHasChildren{/if}">
 				<a href="{$menuItemNode->getMenuItem()->getURL()}" class="boxMenuLink">
 					<span class="boxMenuLinkTitle">{lang}{$menuItemNode->getMenuItem()->title}{/lang}</span>
 					{if $menuItemNode->getMenuItem()->getOutstandingItems() > 0}
diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php
index da5576cb49..bb5d50a0c1 100644
--- a/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php
+++ b/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php
@@ -2,6 +2,7 @@
 namespace wcf\data\menu\item;
 use wcf\data\page\Page;
 use wcf\data\DatabaseObject;
+use wcf\data\page\PageCache;
 use wcf\system\exception\SystemException;
 use wcf\system\page\handler\ILookupPageHandler;
 use wcf\system\page\handler\IMenuPageHandler;
@@ -94,7 +95,7 @@ class MenuItem extends DatabaseObject {
 	 */
 	public function getPage() {
 		if ($this->page === null && $this->pageID) {
-			$this->page = new Page($this->pageID);
+			$this->page = PageCache::getInstance()->getPage($this->pageID);
 		}
 		
 		return $this->page;
diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemNode.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemNode.class.php
index db8fd5f7fb..cc71b93594 100644
--- a/wcfsetup/install/files/lib/data/menu/item/MenuItemNode.class.php
+++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemNode.class.php
@@ -25,6 +25,12 @@ class MenuItemNode implements \Countable, \RecursiveIterator {
 	 */
 	protected $depth = 0;
 	
+	/**
+	 * true if item or one of its children is active
+	 * @var boolean
+	 */
+	protected $isActive = false;
+	
 	/**
 	 * menu item object
 	 * @var	MenuItem
@@ -123,6 +129,27 @@ class MenuItemNode implements \Countable, \RecursiveIterator {
 		return $i;
 	}
 	
+	/**
+	 * Marks this item and all its direct ancestors as active. 
+	 */
+	public function setIsActive() {
+		$this->isActive = true;
+		
+		// propagate active state to immediate parent
+		if ($this->parentNode) {
+			$this->parentNode->setIsActive();
+		}
+	}
+	
+	/**
+	 * Returns true if this item (or one of its children) is marked as active.
+	 * 
+	 * @return      boolean
+	 */
+	public function isActiveNode() {
+		return $this->isActive;
+	}
+	
 	/**
 	 * @inheritDoc
 	 */
diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemNodeTree.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemNodeTree.class.php
index c0c69811be..933b7d2eeb 100644
--- a/wcfsetup/install/files/lib/data/menu/item/MenuItemNodeTree.class.php
+++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemNodeTree.class.php
@@ -1,5 +1,6 @@
 <?php
 namespace wcf\data\menu\item;
+use wcf\system\page\PageLocationManager;
 
 /**
  * Represents a menu item node tree.
@@ -60,6 +61,22 @@ class MenuItemNodeTree {
 			$menuItemList->readObjects();
 		}
 		
+		// find possible active menu items
+		$activeMenuItems = [];
+		$possibleLocations = PageLocationManager::getInstance()->getLocations();
+		$length = count($possibleLocations);
+		foreach ($menuItemList as $menuItem) {
+			for ($i = 0; $i < $length; $i++) {
+				if ($menuItem->pageID == $possibleLocations[$i]['pageID'] && $menuItem->pageObjectID == $possibleLocations[$i]['pageObjectID']) {
+					if (!isset($activeMenuItems[$i])) {
+						$activeMenuItems[$i] = [];
+					}
+					
+					$activeMenuItems[$i][] = $menuItem->itemID;
+				}
+			}
+		}
+		
 		// build menu structure
 		foreach ($menuItemList as $menuItem) {
 			$this->menuItems[$menuItem->itemID] = $menuItem;
@@ -73,6 +90,25 @@ class MenuItemNodeTree {
 		// generate node tree
 		$this->node = new MenuItemNode();
 		$this->node->setChildren($this->generateNodeTree(null, $this->node));
+		
+		// mark nodes as active
+		if (!empty($activeMenuItems)) {
+			$nodeList = $this->getNodeList();
+			foreach ($activeMenuItems as $itemIDs) {
+				for ($i = 0, $length = count($itemIDs); $i < $length; $i++) {
+					/** @var MenuItemNode $node */
+					foreach ($nodeList as $node) {
+						if ($node->getMenuItem()->itemID == $itemIDs[$i]) {
+							$node->setIsActive();
+							
+							// only one effective item can be marked as active, use the first
+							// occurence with the highest priority and ignore everything else
+							return;
+						}
+					}
+				}
+			}
+		}
 	}
 	
 	/**
diff --git a/wcfsetup/install/files/lib/data/page/PageCache.class.php b/wcfsetup/install/files/lib/data/page/PageCache.class.php
new file mode 100644
index 0000000000..71a61e35f3
--- /dev/null
+++ b/wcfsetup/install/files/lib/data/page/PageCache.class.php
@@ -0,0 +1,71 @@
+<?php
+namespace wcf\data\page;
+use wcf\system\cache\builder\PageCacheBuilder;
+use wcf\system\SingletonFactory;
+
+/**
+ * Provides access to the page cache.
+ * 
+ * @author	Alexander Ebert
+ * @copyright	2001-2016 WoltLab GmbH
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package	com.woltlab.wcf
+ * @subpackage	data.page
+ * @category	Community Framework
+ */
+class PageCache extends SingletonFactory {
+	/**
+	 * page cache
+	 * @var array
+	 */
+	protected $cache;
+	
+	/**
+	 * @inheritDoc
+	 */
+	protected function init() {
+		$this->cache = PageCacheBuilder::getInstance()->getData();
+	}
+	
+	/**
+	 * Returns a page by page id or null.
+	 * 
+	 * @param       integer         $pageID         page id
+	 * @return      Page|null
+	 */
+	public function getPage($pageID) {
+		if (isset($this->cache['pages'][$pageID])) {
+			return $this->cache['pages'][$pageID];
+		}
+		
+		return null;
+	}
+	
+	/**
+	 * Returns a page by controller or null.
+	 * 
+	 * @param       string          $controller     controller class name
+	 * @return      Page|null
+	 */
+	public function getPageByController($controller) {
+		if (isset($this->cache['controller'][$controller])) {
+			return $this->getPage($this->cache['controller'][$controller]);
+		}
+		
+		return null;
+	}
+	
+	/**
+	 * Returns a page by its internal identifier or null.
+	 * 
+	 * @param       string          $identifier     internal identifier
+	 * @return      Page|null
+	 */
+	public function getPageByIdentifier($identifier) {
+		if (isset($this->cache['identifier'][$identifier])) {
+			return $this->getPage($this->cache['identifier'][$identifier]);
+		}
+		
+		return null;
+	}
+}
diff --git a/wcfsetup/install/files/lib/system/SingletonFactory.class.php b/wcfsetup/install/files/lib/system/SingletonFactory.class.php
index 677178321c..c917d43bc2 100644
--- a/wcfsetup/install/files/lib/system/SingletonFactory.class.php
+++ b/wcfsetup/install/files/lib/system/SingletonFactory.class.php
@@ -3,10 +3,10 @@ namespace wcf\system;
 use wcf\system\exception\SystemException;
 
 /**
- * Basis class for singleton classes.
+ * Base class for singleton factories.
  *
  * @author	Alexander Ebert
- * @copyright	2001-2015 WoltLab GmbH
+ * @copyright	2001-2016 WoltLab GmbH
  * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package	com.woltlab.wcf
  * @subpackage	system
diff --git a/wcfsetup/install/files/lib/system/cache/builder/PageCacheBuilder.class.php b/wcfsetup/install/files/lib/system/cache/builder/PageCacheBuilder.class.php
new file mode 100644
index 0000000000..b0b115fd9f
--- /dev/null
+++ b/wcfsetup/install/files/lib/system/cache/builder/PageCacheBuilder.class.php
@@ -0,0 +1,38 @@
+<?php
+namespace wcf\system\cache\builder;
+use wcf\data\page\PageList;
+
+/**
+ * Caches the page data.
+ * 
+ * @author	Alexander Ebert
+ * @copyright	2001-2016 WoltLab GmbH
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package	com.woltlab.wcf
+ * @subpackage	system.cache.builder
+ * @category	Community Framework
+ */
+class PageCacheBuilder extends AbstractCacheBuilder {
+	/**
+	 * @inheritDoc
+	 */
+	public function rebuild(array $parameters) {
+		$data = [
+			'identifier' => [],
+			'controller' => [],
+			'pages' => []
+		];
+		
+		$pageList = new PageList();
+		$pageList->readObjects();
+		$data['pages'] = $pageList->getObjects();
+		
+		// build lookup table
+		foreach ($pageList as $page) {
+			$data['identifier'][$page->identifier] = $page->pageID;
+			$data['controller'][$page->controller] = $page->pageID;
+		}
+		
+		return $data;
+	}
+}
diff --git a/wcfsetup/install/files/lib/system/page/PageLocationManager.class.php b/wcfsetup/install/files/lib/system/page/PageLocationManager.class.php
new file mode 100644
index 0000000000..716612a96b
--- /dev/null
+++ b/wcfsetup/install/files/lib/system/page/PageLocationManager.class.php
@@ -0,0 +1,81 @@
+<?php
+namespace wcf\system\page;
+use wcf\data\page\PageCache;
+use wcf\system\exception\SystemException;
+use wcf\system\request\RequestHandler;
+use wcf\system\SingletonFactory;
+
+/**
+ * Handles page locations for use with menu active markings.
+ * 
+ * @author	Alexander Ebert
+ * @copyright	2001-2016 WoltLab GmbH
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package	com.woltlab.wcf
+ * @subpackage	system.page
+ * @category	Community Framework
+ */
+class PageLocationManager extends SingletonFactory {
+	/**
+	 * list of locations with descending priority
+	 * @var array
+	 */
+	protected $stack = [];
+	
+	/**
+	 * @inheritDoc
+	 */
+	public function init() {
+		$pageID = $pageObjectID = 0;
+		
+		$activeRequest = RequestHandler::getInstance()->getActiveRequest();
+		$metaData = $activeRequest->getMetaData();
+		if (isset($metaData['cms'])) {
+			$pageID = $metaData['cms']['pageID'];
+		}
+		else {
+			$page = PageCache::getInstance()->getPageByController($activeRequest->getClassName());
+			if ($page !== null) {
+				$pageID = $page->pageID;
+				
+				if (!empty($_REQUEST['id'])) $pageObjectID = intval($_REQUEST['id']);
+			}
+		}
+		
+		if ($pageID !== null) {
+			$this->stack[] = [
+				'pageID' => $pageID,
+				'pageObjectID' => $pageObjectID
+			];
+		}
+	}
+	
+	/**
+	 * Appends a parent location to the stack, the later it is added the lower
+	 * is its assumed priority when matching suitable menu items.
+	 * 
+	 * @param       string          $identifier     internal page identifier
+	 * @param       integer         $pageObjectID   page object id
+	 * @throws      SystemException
+	 */
+	public function addParentLocation($identifier, $pageObjectID = 0) {
+		$page = PageCache::getInstance()->getPageByIdentifier($identifier);
+		if ($page === null) {
+			throw new SystemException("Unknown page identifier '".$identifier."'.");
+		}
+		
+		$this->stack[] = [
+			'pageID' => $page->pageID,
+			'pageObjectID' => $pageObjectID
+		];
+	}
+	
+	/**
+	 * Returns the list of locations with descending priority.
+	 * 
+	 * @return      array
+	 */
+	public function getLocations() {
+		return $this->stack;
+	}
+}
-- 
2.20.1