oxnavigationtree.php

Go to the documentation of this file.

<?php

class OxNavigationTree extends oxSuperCfg
{

    protected $_oDom = null;

    protected $_oInitialDom = null;

    protected $_sDynIncludeUrl = null;

    protected $_aSupportedExpathXmlEncodings = array('utf-8', 'utf-16', 'iso-8859-1', 'us-ascii');

    protected function _cleanEmptyParents($oDom, $sParentXPath, $sChildXPath)
    {
        $oXPath = new DomXPath($oDom);
        $oNodeList = $oXPath->query($sParentXPath);

        foreach ($oNodeList as $oNode) {
            $sId = $oNode->getAttribute('id');
            $oChildList = $oXPath->query("{$sParentXPath}[@id='$sId']/$sChildXPath");
            if (!$oChildList->length) {
                $oNode->parentNode->removeChild($oNode);
            }
        }
    }

    protected function _addLinks($oDom)
    {
        $sURL = 'index.php?'; // session parameters will be included later (after cache processor)
        $oXPath = new DomXPath($oDom);

        // building
        $oNodeList = $oXPath->query("//SUBMENU[@cl]");
        foreach ($oNodeList as $oNode) {
            // fetching class
            $sCl = $oNode->getAttribute('cl');
            $sCl = $sCl ? "cl=$sCl" : '';

            // fetching params
            $sParam = $oNode->getAttribute('clparam');
            $sParam = $sParam ? "&$sParam" : '';

            // setting link
            $oNode->setAttribute('link', "{$sURL}{$sCl}{$sParam}");
        }
    }

    protected function _loadFromFile($sMenuFile, $oDom)
    {
        $blMerge = false;
        $oDomFile = new DomDocument();
        $oDomFile->preserveWhiteSpace = false;
        if (!@$oDomFile->load($sMenuFile)) {
            $blMerge = true;
        } elseif (is_readable($sMenuFile) && ($sXml = @file_get_contents($sMenuFile))) {

            // looking for non supported character encoding
            if (getStr()->preg_match("/encoding\=(.*)\?>/", $sXml, $aMatches) !== 0) {
                if (isset($aMatches[1])) {
                    $sCurrEncoding = trim($aMatches[1], "\"");
                    if (!in_array(strtolower($sCurrEncoding), $this->_aSupportedExpathXmlEncodings)) {
                        $sXml = str_replace($aMatches[1], "\"UTF-8\"", $sXml);
                        $sXml = iconv($sCurrEncoding, "UTF-8", $sXml);
                    }
                }
            }

            // load XML as string
            if (@$oDomFile->loadXml($sXml)) {
                $blMerge = true;
            }
        }

        if ($blMerge) {
            $this->_merge($oDomFile, $oDom);
        }
    }

    protected function _addDynLinks($oDom)
    {
        $myConfig = $this->getConfig();
        $myUtilsFile = oxRegistry::get("oxUtilsFile");

        $sURL = 'index.php?'; // session parameters will be included later (after cache processor)

        $oXPath = new DomXPath($oDom);
        $oNodeList = $oXPath->query("//OXMENU[@type='dyn']/MAINMENU/SUBMENU");

        foreach ($oNodeList as $oNode) {

            // fetching class
            $sCl = $oNode->getAttribute('cl');
            $sCl = "cl=dynscreen&menu=$sCl";

            // fetching params
            $sParam = $oNode->getAttribute('clparam');
            $sParam = $sParam ? "&$sParam" : '';

            // setting list node if its is not set yet
            if (!$oNode->getAttribute('list')) {
                $oNode->setAttribute('list', 'dynscreen_list');
                $oNode->setAttribute('listparam', 'menu=' . $oNode->getAttribute('cl'));
            }

            // setting link
            $oNode->setAttribute('link', "{$sURL}{$sCl}{$sParam}");

            // setting id
            $oNode->parentNode->setAttribute('id', 'dyn_menu');

            // setting id to its parent

            // fetching class
            $sFile = $oNode->getAttribute('cl');

            // always display the "about" tab no matter what licence

            if ($myUtilsFile->checkFile("{$this->_sDynIncludeUrl}pages/{$sFile}_about.php")) {
                $oTabElem = new DOMElement('TAB');
                $oNode->appendChild($oTabElem);
                $oTabElem->setAttribute('external', 'true');
                $oTabElem->setAttribute('location', "{$this->_sDynIncludeUrl}pages/{$sFile}_about.php");
                $oTabElem->setAttribute('id', 'dyn_about');
            }

            // checking for technics page
            if ($myUtilsFile->checkFile("{$this->_sDynIncludeUrl}pages/{$sFile}_technics.php")) {
                $oTabElem = new DOMElement('TAB');
                $oNode->appendChild($oTabElem);
                $oTabElem->setAttribute('external', 'true');
                $oTabElem->setAttribute('location', "{$this->_sDynIncludeUrl}pages/{$sFile}_technics.php");
                $oTabElem->setAttribute('id', 'dyn_interface');
            }

            // checking for setup page
            if (file_exists($myConfig->getConfigParam('sShopDir') . "/application/controllers/admin/{$sFile}.php")) {
                $oTabElem = new DOMElement('TAB');
                $oNode->appendChild($oTabElem);
                $oTabElem->setAttribute('id', 'dyn_interface');
                $oTabElem->setAttribute('cl', $sFile);
            }
        }
    }

    protected function _sessionizeLocalUrls($oDom)
    {
        $sURL = $this->_getAdminUrl();
        $oXPath = new DomXPath($oDom);
        $oStr = getStr();
        foreach (array('url', 'link') as $sAttrType) {
            foreach ($oXPath->query("//OXMENU//*[@$sAttrType]") as $oNode) {
                $sLocalUrl = $oNode->getAttribute($sAttrType);
                if (strpos($sLocalUrl, 'index.php?') === 0) {
                    $sLocalUrl = $oStr->preg_replace('#^index.php\?#', $sURL, $sLocalUrl);
                    $oNode->setAttribute($sAttrType, $sLocalUrl);
                }
            }
        }
    }

    protected function _checkRights($oDom)
    {
        $oXPath = new DomXPath($oDom);
        $oNodeList = $oXPath->query('//*[@rights or @norights]');

        foreach ($oNodeList as $oNode) {
            // only allowed modules/user rights or so
            if (($sReq = $oNode->getAttribute('rights'))) {
                $aPerm = explode(',', $sReq);
                foreach ($aPerm as $sPerm) {
                    if ($sPerm && !$this->_hasRights($sPerm)) {
                        $oNode->parentNode->removeChild($oNode);
                    }
                }
                // not allowed modules/user rights or so
            } elseif (($sNoReq = $oNode->getAttribute('norights'))) {
                $aPerm = explode(',', $sNoReq);
                foreach ($aPerm as $sPerm) {
                    if ($sPerm && $this->_hasRights($sPerm)) {
                        $oNode->parentNode->removeChild($oNode);
                    }
                }
            }
        }
    }

    protected function _checkGroups($oDom)
    {
        $oXPath = new DomXPath($oDom);
        $oNodeList = $oXPath->query("//*[@nogroup or @group]");

        foreach ($oNodeList as $oNode) {
            // allowed only for groups
            if (($sReq = $oNode->getAttribute('group'))) {
                $aPerm = explode(',', $sReq);
                foreach ($aPerm as $sPerm) {
                    if ($sPerm && !$this->_hasGroup($sPerm)) {
                        $oNode->parentNode->removeChild($oNode);
                    }
                }
                // not allowed for groups
            } elseif (($sNoReq = $oNode->getAttribute('nogroup'))) {
                $aPerm = explode(',', $sNoReq);
                foreach ($aPerm as $sPerm) {
                    if ($sPerm && $this->_hasGroup($sPerm)) {
                        $oNode->parentNode->removeChild($oNode);
                    }
                }
            }
        }
    }

    protected function _checkDemoShopDenials($oDom)
    {
        if (!$this->getConfig()->isDemoShop()) {
            // nothing to check for non demo shop
            return;
        }

        $oXPath = new DomXPath($oDom);
        $oNodeList = $oXPath->query("//*[@disableForDemoShop]");
        foreach ($oNodeList as $oNode) {
            if ($oNode->getAttribute('disableForDemoShop')) {
                $oNode->parentNode->removeChild($oNode);
            }
        }
    }

    protected function removeInvisibleMenuNodes($oDom)
    {
        $oXPath = new DomXPath($oDom);
        $oNodeList = $oXPath->query("//*[@visible]");
        foreach ($oNodeList as $oNode) {
            if (!$oNode->getAttribute('visible')) {
                $oNode->parentNode->removeChild($oNode);
            }
        }
    }

    protected function _copyAttributes($oDomElemTo, $oDomElemFrom)
    {
        foreach ($oDomElemFrom->attributes as $oAttr) {
            $oDomElemTo->setAttribute($oAttr->nodeName, $oAttr->nodeValue);
        }
    }

    protected function _mergeNodes($oDomElemTo, $oDomElemFrom, $oXPathTo, $oDomDocTo, $sQueryStart)
    {
        foreach ($oDomElemFrom->childNodes as $oFromNode) {
            if ($oFromNode->nodeType === XML_ELEMENT_NODE) {

                $sFromAttrName = $oFromNode->getAttribute('id');
                $sFromNodeName = $oFromNode->tagName;

                // find current item
                $sQuery = "{$sQueryStart}/{$sFromNodeName}[@id='{$sFromAttrName}']";
                $oCurNode = $oXPathTo->query($sQuery);

                // if not found - append
                if ($oCurNode->length == 0) {
                    $oDomElemTo->appendChild($oDomDocTo->importNode($oFromNode, true));
                } else {

                    $oCurNode = $oCurNode->item(0);

                    // if found copy all attributes and check childnodes
                    $this->_copyAttributes($oCurNode, $oFromNode);

                    if ($oFromNode->childNodes->length) {
                        $this->_mergeNodes($oCurNode, $oFromNode, $oXPathTo, $oDomDocTo, $sQuery);
                    }
                }
            }
        }
    }

    protected function _merge($oDomNew, $oDom)
    {
        $oXPath = new DOMXPath($oDom);
        $this->_mergeNodes($oDom->documentElement, $oDomNew->documentElement, $oXPath, $oDom, '/OX');
    }

    public function getTabs($sId, $iAct, $blSetActive = true)
    {
        $oXPath = new DOMXPath($this->getDomXml());
        //$oNodeList = $oXPath->query( "//SUBMENU[@cl='$sId' or @list='$sId']/TAB | //SUBMENU/../TAB[@cl='$sId']" );
        $oNodeList = $oXPath->query("//SUBMENU[@cl='$sId']/TAB | //SUBMENU[@list='$sId']/TAB | //SUBMENU/../TAB[@cl='$sId']");

        $iAct = ($iAct > $oNodeList->length) ? ($oNodeList->length - 1) : $iAct;

        if ($blSetActive) {
            foreach ($oNodeList as $iPos => $oNode) {
                if ($iPos == $iAct) {
                    // marking active node
                    $oNode->setAttribute('active', 1);
                }
            }
        }

        return $oNodeList;
    }

    public function getActiveTab($sId, $iAct)
    {
        $sTab = null;
        $oNodeList = $this->getTabs($sId, $iAct, false);
        $iAct = ($iAct > $oNodeList->length) ? ($oNodeList->length - 1) : $iAct;
        if ($oNodeList->length && ($oNode = $oNodeList->item($iAct))) {
            $sTab = $oNode->getAttribute('cl');
        }

        return $sTab;
    }

    public function getBtn($sClass)
    {
        $oButtons = null;
        $oXPath = new DOMXPath($this->getDomXml());
        $oNodeList = $oXPath->query("//TAB[@cl='$sClass']/../BTN");
        if ($oNodeList->length) {
            $oButtons = new stdClass();
            foreach ($oNodeList as $oNode) {
                $sBtnID = $oNode->getAttribute('id');
                $oButtons->$sBtnID = 1;
            }
        }

        return $oButtons;
    }

    protected function _getMenuFiles()
    {
        $myConfig = $this->getConfig();
        $myOxUtlis = oxRegistry::getUtils();

        $sFullAdminDir = getShopBasePath() . 'application/views/admin';
        $sMenuFile = "/menu.xml";

        $sTmpDir = $myConfig->getConfigParam('sCompileDir');
        $sDynLang = $this->_getDynMenuLang();
        $sLocalDynPath = "{$sTmpDir}{$sDynLang}_dynscreen.xml";


        // including std file
        if (file_exists($sFullAdminDir . $sMenuFile)) {
            $aFilesToLoad[] = $sFullAdminDir . $sMenuFile;
        }

        // including custom file
        if (file_exists("$sFullAdminDir/user.xml")) {
            $aFilesToLoad[] = "$sFullAdminDir/user.xml";
        }

        // including module menu files
        $sPath = getShopBasePath();
        $oModulelist = oxNew('oxmodulelist');
        $aActiveModuleInfo = $oModulelist->getActiveModuleInfo();
        if (is_array($aActiveModuleInfo)) {
            foreach ($aActiveModuleInfo as $sModulePath) {
                $sFullPath = $sPath . "modules/" . $sModulePath;
                // missing file/folder?
                if (is_dir($sFullPath)) {
                    // including menu file
                    $sMenuFile = $sFullPath . "/menu.xml";
                    if (file_exists($sMenuFile) && is_readable($sMenuFile)) {
                        $aFilesToLoad[] = $sMenuFile;
                    }
                }
            }
        }

        $blLoadDynContents = $myConfig->getConfigParam('blLoadDynContents');
        $sShopCountry = $myConfig->getConfigParam('sShopCountry');

        // including dyn menu file
        $sDynPath = null;

        if ($blLoadDynContents) {
            if ($sShopCountry) {
                $sRemoteDynUrl = $this->_getDynMenuUrl($sDynLang, $blLoadDynContents);

                // loading remote file from server only once
                $blLoadRemote = oxRegistry::getSession()->getVariable("loadedremotexml");

                // very basic check if its valid xml file
                if ((!isset($blLoadRemote) || $blLoadRemote) && ($sDynPath = $myOxUtlis->getRemoteCachePath($sRemoteDynUrl, $sLocalDynPath))) {
                    $sDynPath = $this->_checkDynFile($sDynPath);
                }

                // caching last load state
                oxRegistry::getSession()->setVariable("loadedremotexml", $sDynPath ? true : false);
            }
        } else {
            if ($sShopCountry) {
                //non international country
            }
        }

        // loading dynpages
        if ($sDynPath) {
            $aFilesToLoad[] = $sDynPath;
        }

        return $aFilesToLoad;
    }

    protected function _checkDynFile($sDynFilePath)
    {
        $sDynFile = null;
        if (file_exists($sDynFilePath)) {
            $sLine = null;
            if (($rHandle = @fopen($sDynFilePath, 'r'))) {
                $sLine = stream_get_line($rHandle, 100, "?>");
                fclose($rHandle);

                // checking xml file header
                if ($sLine && stripos($sLine, '<?xml') !== false) {
                    $sDynFile = $sDynFilePath;
                }
            }

            // cleanup ..
            if (!$sDynFile) {
                @unlink($sDynFilePath);
            }
        }

        return $sDynFile;
    }

    protected function _processCachedFile($sCacheContents)
    {

        return $sCacheContents;
    }

    protected function _getInitialDom()
    {
        if ($this->_oInitialDom === null) {
            $myOxUtlis = oxRegistry::getUtils();

            if (is_array($aFilesToLoad = $this->_getMenuFiles())) {

                // now checking if xml files are newer than cached file
                $blReload = false;
                $sDynLang = $this->_getDynMenuLang();

                $sShopId = $this->getConfig()->getActiveShop()->getShopId();
                $sCacheName = 'menu_' . $sDynLang . $sShopId . '_xml';
                $sCacheFile = $myOxUtlis->getCacheFilePath($sCacheName);
                $sCacheContents = $myOxUtlis->fromFileCache($sCacheName);
                if ($sCacheContents && file_exists($sCacheFile) && ($iCacheModTime = filemtime($sCacheFile))) {
                    foreach ($aFilesToLoad as $sDynPath) {
                        if ($iCacheModTime < filemtime($sDynPath)) {
                            $blReload = true;
                        }
                    }
                } else {
                    $blReload = true;
                }

                $this->_oInitialDom = new DOMDocument();
                if ($blReload) {
                    // fully reloading and building pathes
                    $this->_oInitialDom->appendChild(new DOMElement('OX'));

                    foreach ($aFilesToLoad as $sDynPath) {
                        $this->_loadFromFile($sDynPath, $this->_oInitialDom);
                    }

                    // adds links to menu items
                    $this->_addLinks($this->_oInitialDom);

                    // @deprecated since v5.3 (2016-05-20); Dynpages will be removed.
                    // adds links to dynamic parts
                    $this->_addDynLinks($this->_oInitialDom);
                    // END deprecated

                    // writing to cache
                    $myOxUtlis->toFileCache($sCacheName, $this->_oInitialDom->saveXML());
                } else {
                    $sCacheContents = $this->_processCachedFile($sCacheContents);
                    // loading from cached file
                    $this->_oInitialDom->preserveWhiteSpace = false;
                    $this->_oInitialDom->loadXML($sCacheContents);
                }

                // add session params
                $this->_sessionizeLocalUrls($this->_oInitialDom);
            }
        }

        return $this->_oInitialDom;
    }

    public function getDomXml()
    {
        if ($this->_oDom === null) {
            $this->_oDom = clone $this->_getInitialDom();

            // removes items denied by user group
            $this->_checkGroups($this->_oDom);

            // removes items denied by user rights
            $this->_checkRights($this->_oDom);

            // check config params
            $this->_checkDemoShopDenials($this->_oDom);

            // removes items marked as not visible
            $this->removeInvisibleMenuNodes($this->_oDom);


            $this->_cleanEmptyParents($this->_oDom, '//SUBMENU[@id][@list]', 'TAB');
            $this->_cleanEmptyParents($this->_oDom, '//MAINMENU[@id]', 'SUBMENU');
        }

        return $this->_oDom;
    }

    public function getListNodes($aNodes)
    {
        $oXPath = new DOMXPath($this->getDomXml());
        $oNodeList = $oXPath->query("//SUBMENU[@cl='" . implode("' or @cl='", $aNodes) . "']");

        return ($oNodeList->length) ? $oNodeList : null;
    }

    public function markNodeActive($sNodeId)
    {
        $oXPath = new DOMXPath($this->getDomXml());
        $oNodeList = $oXPath->query("//*[@cl='{$sNodeId}' or @list='{$sNodeId}']");

        if ($oNodeList->length) {
            foreach ($oNodeList as $oNode) {
                // special case for external resources
                $oNode->setAttribute('active', 1);
                $oNode->parentNode->setAttribute('active', 1);
            }
        }

    }

    public function getListUrl($sId)
    {
        $sUrl = null;
        $oXPath = new DOMXPath($this->getDomXml());
        $oNodeList = $oXPath->query("//SUBMENU[@cl='{$sId}']");
        if ($oNodeList->length && ($oNode = $oNodeList->item(0))) {
            $sCl = $oNode->getAttribute('list');
            $sCl = $sCl ? "cl=$sCl" : '';

            $sParams = $oNode->getAttribute('listparam');
            $sParams = $sParams ? "&$sParams" : '';

            $sUrl = "{$sCl}{$sParams}";
        }

        return $sUrl;
    }

    public function getEditUrl($sId, $iActTab)
    {
        $sUrl = null;
        $oXPath = new DOMXPath($this->getDomXml());
        $oNodeList = $oXPath->query("//SUBMENU[@cl='{$sId}']/TAB");

        $iActTab = ($iActTab > $oNodeList->length) ? ($oNodeList->length - 1) : $iActTab;
        if ($oNodeList->length && ($oActTab = $oNodeList->item($iActTab))) {
            // special case for external resources
            if ($oActTab->getAttribute('external')) {
                $sUrl = $oActTab->getAttribute('location');
            } else {
                $sCl = $oActTab->getAttribute('cl');
                $sCl = $sCl ? "cl={$sCl}" : '';

                $sParams = $oActTab->getAttribute('clparam');
                $sParams = $sParams ? "&{$sParams}" : '';

                $sUrl = "{$sCl}{$sParams}";
            }
        }

        return $sUrl;
    }

    protected function _getAdminUrl()
    {
        $myConfig = $this->getConfig();

        if (($sAdminSslUrl = $myConfig->getConfigParam('sAdminSSLURL'))) {
            $sURL = trim($sAdminSslUrl, '/');
        } else {
            $sURL = trim($myConfig->getConfigParam('sShopURL'), '/') . '/admin';
        }

        return oxRegistry::get("oxUtilsUrl")->processUrl("{$sURL}/index.php", false);
    }

    protected function _hasRights($sRights)
    {
        return $this->getUser()->oxuser__oxrights->value == $sRights;
    }

    protected function _hasGroup($sGroupId)
    {
        return $this->getUser()->inGroup($sGroupId);
    }

    public function getClassId($sClassName)
    {
        $sClassId = null;

        $oXPath = new DOMXPath($this->_getInitialDom());
        $oNodeList = $oXPath->query("//*[@cl='{$sClassName}' or @list='{$sClassName}']");
        if ($oNodeList->length && ($oFirstItem = $oNodeList->item(0))) {
            $sClassId = $oFirstItem->getAttribute('id');
        }

        return $sClassId;
    }


    protected function _getDynMenuUrl($iLang, $blLoadDynContents)
    {
        if (!$blLoadDynContents) {
            // getting dyn info from oxid server is off, so getting local menu path
            $sFullAdminDir = getShopBasePath() . 'application/views/admin';
            $sUrl = $sFullAdminDir . "/dynscreen_local.xml";
        } else {
            $oAdminView = oxNew('oxadminview');
            $this->_sDynIncludeUrl = $oAdminView->getServiceUrl($iLang);
            $sUrl .= $this->_sDynIncludeUrl . "menue/dynscreen.xml";
        }

        return $sUrl;
    }

    protected function _getDynMenuLang()
    {
        $myConfig = $this->getConfig();
        $oLang = oxRegistry::getLang();

        $iDynLang = $myConfig->getConfigParam('iDynInterfaceLanguage');
        $iDynLang = isset($iDynLang) ? $iDynLang : ($oLang->getTplLanguage());

        $aLanguages = $oLang->getLanguageArray();
        $sLangAbr = $aLanguages[$iDynLang]->abbr;

        return $sLangAbr;
    }
}