1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Adminhtml
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * Adminhtml menu block
 29:  *
 30:  * @method Mage_Adminhtml_Block_Page_Menu setAdditionalCacheKeyInfo(array $cacheKeyInfo)
 31:  * @method array getAdditionalCacheKeyInfo()
 32:  *
 33:  * @category   Mage
 34:  * @package    Mage_Adminhtml
 35:  * @author     Magento Core Team <core@magentocommerce.com>
 36:  */
 37: class Mage_Adminhtml_Block_Page_Menu extends Mage_Adminhtml_Block_Template
 38: {
 39:     const CACHE_TAGS = 'BACKEND_MAINMENU';
 40: 
 41:     /**
 42:      * Adminhtml URL instance
 43:      *
 44:      * @var Mage_Adminhtml_Model_Url
 45:      */
 46:     protected $_url;
 47: 
 48:     /**
 49:      * Initialize template and cache settings
 50:      *
 51:      */
 52:     protected function _construct()
 53:     {
 54:         parent::_construct();
 55:         $this->setTemplate('page/menu.phtml');
 56:         $this->_url = Mage::getModel('adminhtml/url');
 57:         $this->setCacheTags(array(self::CACHE_TAGS));
 58:     }
 59: 
 60:     /**
 61:      * Retrieve cache lifetime
 62:      *
 63:      * @return int
 64:      */
 65:     public function getCacheLifetime()
 66:     {
 67:         return 86400;
 68:     }
 69: 
 70:     /**
 71:      * Get Key pieces for caching block content
 72:      *
 73:      * @return array
 74:      */
 75:     public function getCacheKeyInfo()
 76:     {
 77:         $cacheKeyInfo = array(
 78:             'admin_top_nav',
 79:             $this->getActive(),
 80:             Mage::getSingleton('admin/session')->getUser()->getId(),
 81:             Mage::app()->getLocale()->getLocaleCode()
 82:         );
 83:         // Add additional key parameters if needed
 84:         $additionalCacheKeyInfo = $this->getAdditionalCacheKeyInfo();
 85:         if (is_array($additionalCacheKeyInfo) && !empty($additionalCacheKeyInfo)) {
 86:             $cacheKeyInfo = array_merge($cacheKeyInfo, $additionalCacheKeyInfo);
 87:         }
 88:         return $cacheKeyInfo;
 89:     }
 90: 
 91:     /**
 92:      * Retrieve Adminhtml Menu array
 93:      *
 94:      * @return array
 95:      */
 96:     public function getMenuArray()
 97:     {
 98:         return $this->_buildMenuArray();
 99:     }
100: 
101:     /**
102:      * Retrieve Title value for menu node
103:      *
104:      * @param Varien_Simplexml_Element $child
105:      * @return string
106:      */
107:     protected function _getHelperValue(Varien_Simplexml_Element $child)
108:     {
109:         $helperName         = 'adminhtml';
110:         $titleNodeName      = 'title';
111:         $childAttributes    = $child->attributes();
112:         if (isset($childAttributes['module'])) {
113:             $helperName     = (string)$childAttributes['module'];
114:         }
115: //        if (isset($childAttributes['translate'])) {
116: //            $titleNodeName  = (string)$childAttributes['translate'];
117: //        }
118: 
119:         return Mage::helper($helperName)->__((string)$child->$titleNodeName);
120:     }
121: 
122:     /**
123:      * Recursive Build Menu array
124:      *
125:      * @param Varien_Simplexml_Element $parent
126:      * @param string $path
127:      * @param int $level
128:      * @return array
129:      */
130:     protected function _buildMenuArray(Varien_Simplexml_Element $parent=null, $path='', $level=0)
131:     {
132:         if (is_null($parent)) {
133:             $parent = Mage::getSingleton('admin/config')->getAdminhtmlConfig()->getNode('menu');
134:         }
135: 
136:         $parentArr = array();
137:         $sortOrder = 0;
138:         foreach ($parent->children() as $childName => $child) {
139:             if (1 == $child->disabled) {
140:                 continue;
141:             }
142: 
143:             $aclResource = 'admin/' . ($child->resource ? (string)$child->resource : $path . $childName);
144:             if (!$this->_checkAcl($aclResource)) {
145:                 continue;
146:             }
147: 
148:             if ($child->depends && !$this->_checkDepends($child->depends)) {
149:                 continue;
150:             }
151: 
152:             $menuArr = array();
153: 
154:             $menuArr['label'] = $this->_getHelperValue($child);
155: 
156:             $menuArr['sort_order'] = $child->sort_order ? (int)$child->sort_order : $sortOrder;
157: 
158:             if ($child->action) {
159:                 $menuArr['url'] = $this->_url->getUrl((string)$child->action, array('_cache_secret_key' => true));
160:             } else {
161:                 $menuArr['url'] = '#';
162:                 $menuArr['click'] = 'return false';
163:             }
164: 
165:             $menuArr['active'] = ($this->getActive()==$path.$childName)
166:                 || (strpos($this->getActive(), $path.$childName.'/')===0);
167: 
168:             $menuArr['level'] = $level;
169: 
170:             if ($child->children) {
171:                 $menuArr['children'] = $this->_buildMenuArray($child->children, $path.$childName.'/', $level+1);
172:             }
173:             $parentArr[$childName] = $menuArr;
174: 
175:             $sortOrder++;
176:         }
177: 
178:         uasort($parentArr, array($this, '_sortMenu'));
179: 
180:         while (list($key, $value) = each($parentArr)) {
181:             $last = $key;
182:         }
183:         if (isset($last)) {
184:             $parentArr[$last]['last'] = true;
185:         }
186: 
187:         return $parentArr;
188:     }
189: 
190:     /**
191:      * Sort menu comparison function
192:      *
193:      * @param int $a
194:      * @param int $b
195:      * @return int
196:      */
197:     protected function _sortMenu($a, $b)
198:     {
199:         return $a['sort_order']<$b['sort_order'] ? -1 : ($a['sort_order']>$b['sort_order'] ? 1 : 0);
200:     }
201: 
202:     /**
203:      * Check Depends
204:      *
205:      * @param Varien_Simplexml_Element $depends
206:      * @return bool
207:      */
208:     protected function _checkDepends(Varien_Simplexml_Element $depends)
209:     {
210:         if ($depends->module) {
211:             $modulesConfig = Mage::getConfig()->getNode('modules');
212:             foreach ($depends->module as $module) {
213:                 if (!$modulesConfig->$module || !$modulesConfig->$module->is('active')) {
214:                     return false;
215:                 }
216:             }
217:         }
218: 
219:         if ($depends->config) {
220:             foreach ($depends->config as $path) {
221:                 if (!Mage::getStoreConfigFlag((string)$path)) {
222:                     return false;
223:                 }
224:             }
225:         }
226: 
227:         return true;
228:     }
229: 
230:     /*protected function _checkAcl(Varien_Simplexml_Element $acl)
231:     {
232:         return true;
233:         $resource = (string)$acl->resource;
234:         $privilege = (string)$acl->privilege;
235:         return Mage::getSingleton('admin/session')->isAllowed($resource, $privilege);
236:     }*/
237: 
238:     /**
239:      * Check is Allow menu item for admin user
240:      *
241:      * @param string $resource
242:      * @return bool
243:      */
244:     protected function _checkAcl($resource)
245:     {
246:         try {
247:             $res =  Mage::getSingleton('admin/session')->isAllowed($resource);
248:         } catch (Exception $e) {
249:             return false;
250:         }
251:         return $res;
252:     }
253: 
254:     /**
255:      * Processing block html after rendering
256:      *
257:      * @param   string $html
258:      * @return  string
259:      */
260:     protected function _afterToHtml($html)
261:     {
262:         $html = preg_replace_callback('#'.Mage_Adminhtml_Model_Url::SECRET_KEY_PARAM_NAME.'/\$([^\/].*)/([^\$].*)\$#', array($this, '_callbackSecretKey'), $html);
263: 
264:         return $html;
265:     }
266: 
267:     /**
268:      * Replace Callback Secret Key
269:      *
270:      * @param array $match
271:      * @return string
272:      */
273:     protected function _callbackSecretKey($match)
274:     {
275:         return Mage_Adminhtml_Model_Url::SECRET_KEY_PARAM_NAME . '/'
276:             . $this->_url->getSecretKey($match[1], $match[2]);
277:     }
278: 
279:     /**
280:      * Get menu level HTML code
281:      *
282:      * @param array $menu
283:      * @param int $level
284:      * @return string
285:      */
286:     public function getMenuLevel($menu, $level = 0)
287:     {
288:         $html = '<ul ' . (!$level ? 'id="nav"' : '') . '>' . PHP_EOL;
289:         foreach ($menu as $item) {
290:             $html .= '<li ' . (!empty($item['children']) ? 'onmouseover="Element.addClassName(this,\'over\')" '
291:                 . 'onmouseout="Element.removeClassName(this,\'over\')"' : '') . ' class="'
292:                 . (!$level && !empty($item['active']) ? ' active' : '') . ' '
293:                 . (!empty($item['children']) ? ' parent' : '')
294:                 . (!empty($level) && !empty($item['last']) ? ' last' : '')
295:                 . ' level' . $level . '"> <a href="' . $item['url'] . '" '
296:                 . (!empty($item['title']) ? 'title="' . $item['title'] . '"' : '') . ' '
297:                 . (!empty($item['click']) ? 'onclick="' . $item['click'] . '"' : '') . ' class="'
298:                 . ($level === 0 && !empty($item['active']) ? 'active' : '') . '"><span>'
299:                 . $this->escapeHtml($item['label']) . '</span></a>' . PHP_EOL;
300: 
301:             if (!empty($item['children'])) {
302:                 $html .= $this->getMenuLevel($item['children'], $level + 1);
303:             }
304:             $html .= '</li>' . PHP_EOL;
305:         }
306:         $html .= '</ul>' . PHP_EOL;
307: 
308:         return $html;
309:     }
310: }
311: