ChWsbMemberMenu.php

Go to the documentation of this file.

<?php
 
    class ChWsbMemberMenu
    {
        // contain all registered menu's bubbles;
        var $sBubbles = null;
 
        // contain current menu possition (allowed values : top, bottom, fixed)
        var $sMemberMenuPosition = null;
 
        var $iBubblesUpdateTime  = 30000; // in milliseconds;
 
        var $iNotifyDestroyTime  = 3000; // in milliseconds;
 
        // page that will procces all ajax queries from member menu ;
        var $sQueryPageReciver = 'member_menu_queries.php';
 
        var $sBubblePrefix = 'bubble_';
        var $sMenuPopupPrefix = 'extra_menu_popup_';
        var $sDescriptionPrefix = 'descr_';
 
        var $oCacheObject;
 
        var $iKeysFileTTL = 600; //cache life time
        var $sMenuCacheFile = 'sys_menu_member';
        var $sMenuMemberKeysCache = 'mm_sys_menu_member_keys_';
 
        function __construct()
        {
            $this -> sMemberMenuPosition = ( isset($_COOKIE['menu_position']) )
                ? $_COOKIE['menu_position']
                : getParam( 'ext_nav_menu_top_position' );
        }
 
        function getGetExtraMenuLink(&$aLinkInfo)
        {
            global $oSysTemplate;
 
            $aTemplateKeys = array(
 
                'item_img'      => $GLOBALS['oFunctions']->sysImage($aLinkInfo['item_img_src'], '', $aLinkInfo['item_title'], '', 'icon'),
                'item_link'     => $aLinkInfo['item_link'],
                'item_onclick'  => ($aLinkInfo['item_onclick']) ? ' onclick="' . $aLinkInfo['item_onclick'] . ';return false"' : null,
                'item_title'    => $aLinkInfo['item_title'],
 
                'extra_info'    => ($aLinkInfo['extra_info']) ? ' (' . $aLinkInfo['extra_info'] . ')' : null,
            );
 
            $sOutputCode = $oSysTemplate -> parseHtmlByName( 'member_menu_sub_item.html', $aTemplateKeys );
            return $sOutputCode;
        }
 
        function getDescriptionWindow($sDescription)
        {
            global $oSysTemplate;
 
            $aTemplateKeys = array(
                'description' => $sDescription,
            );
 
            $sOutputCode = $oSysTemplate -> parseHtmlByName( 'member_menu_descr_window.html', $aTemplateKeys );
            return $sOutputCode;
        }
 
        function getCacheObject()
        {
            if ($this -> oCacheObject != null) {
                return $this->oCacheObject;
            } else {
                $sEngine = getParam('sys_mm_cache_engine');
                $this->oCacheObject = ch_instance ('ChWsbCache'.$sEngine);
                if (!$this->oCacheObject->isAvailable())
                    $this->oCacheObject = ch_instance ('ChWsbCacheFile');
                return $this->oCacheObject;
            }
        }
 
        function _parseStructure($aMemberInfo, $aMenuStructure)
        {
            global $oSysTemplate, $oFunctions;
 
            if(!$aMenuStructure) {
                return;
            }
 
               $oCache = $this -> getCacheObject();
 
            $oPermalinks   = new ChWsbPermalinks();
 
            $aReplaced = $aDefinedMenuItems = array();
            $memberID = $aMemberInfo['ID'];
            $iIndex = 0;
            $sStartPosition = '';
 
            //-- process menu structure --//
            $aDefinedMenuItems = $oCache->getData(
                $this -> getCacheKey($aMemberInfo['ID']), $this -> iKeysFileTTL);
 
            if(!$aDefinedMenuItems) {
                foreach($aMenuStructure AS $sPosition => $aMenuItems ) {
                    foreach($aMenuItems as $iKey => $aItems) {
                        $isSkipItem = false;
                        foreach($aItems AS $sMenuKey => $sValue ) {
                            if ( $sMenuKey != 'PopupMenu' && $sMenuKey != 'linked_items' ) {
                                if ( $sMenuKey == 'Caption' ) {
                                    $aReplaced[$sPosition][$iKey][$sMenuKey] = $oFunctions -> markerReplace($aMemberInfo, $sValue, $aItems['Eval'], true);
                                } else {
                                    $aReplaced[$sPosition][$iKey][$sMenuKey] = $oFunctions -> markerReplace($aMemberInfo, $sValue, $aItems['Eval']);
                                }
                            } else {
                                $aReplaced[$sPosition][$iKey][$sMenuKey] = $sValue;
                            }
                        }
 
                        if($sStartPosition != $sPosition) {
                            $iIndex = 0;
                            $sStartPosition = $sPosition;
                        }
 
                        //-- process next --//
                        // collect the link;
                        if ( $aReplaced[$sPosition][$iKey]['Type'] == 'link'
                                && $aReplaced[$sPosition][$iKey]['Caption']
                                && ($aReplaced[$sPosition][$iKey]['Link'] || $aReplaced[$sPosition][$iKey]['Script']) ) {
 
                                $sMenuClass = '';
                                if($sPosition == 'top_extra') {
                                    $sMenuClass = 'extra_item {evalResultCssClassWrapper}';
                                    $sMenuClass = $oFunctions -> markerReplace($aMemberInfo, $sMenuClass, $aItems['Eval']);
                                }
 
                                $sPartCaption = $aReplaced[$sPosition][$iKey]['Caption'];
 
                                //define some settings for "Member block" ;
                                if($aReplaced[$sPosition][$iKey]['Name'] == 'MemberBlock') {
                                    $oUserStatus   = new ChWsbUserStatusView();
 
                                    $sUserThumbnail = $GLOBALS['oFunctions']->getMemberAvatar($aMemberInfo['ID'], 'small');
                                    $sUserThumbnailDouble = $GLOBALS['oFunctions']->getMemberAvatar($aMemberInfo['ID'], 'small', true);
                                    if(empty($sUserThumbnailDouble))
                                        $sUserThumbnailDouble = $sUserThumbnail;
 
                                    $bUserThumbnail = !empty($sUserThumbnail);
 
                                    $sMenuImage = $GLOBALS['oSysTemplate']->parseHtmlByName('member_menu_thumbnail.html', array(
                                        'ch_if:show_thumbnail_image' => array(
                                            'condition' => $bUserThumbnail,
                                            'content' => array(
                                                'thumbnail_url' => $sUserThumbnail,
                                                'thumbnail_url_2x' => $sUserThumbnailDouble,
                                            )
                                        ),
                                        'ch_if:show_thumbnail_icon' => array(
                                            'condition' => !$bUserThumbnail,
                                            'content' => array()
                                        ),
                                        'status_icon' => $oUserStatus->getStatusIcon($aMemberInfo['ID'], 'icon8'),
                                        'status_title' => $oUserStatus->getStatus($aMemberInfo['ID']),
                                    ));
 
                                    $sReduceImage = '';
                                }
                                else {
                                    $sMenuImage = $aReplaced[$sPosition][$iKey]['Icon'];
                                    if(strpos($sMenuImage, '.') !== false)
                                        $sMenuImage = getTemplateIcon($sMenuImage);
 
                                    $sReduceImage = $sMenuImage;
                                    $sMenuImage = $this->getImage($sMenuImage);
                                }
 
                                if ($aReplaced[$sPosition][$iKey]['Caption'] == '{system}') {
                                    $sMenuImage = $aReplaced[$sPosition][$iKey]['Icon'] ? $aReplaced[$sPosition][$iKey]['Icon'] : 'spacer.gif';
                                    if(strpos($sMenuImage, '.') !== false)
                                        $sMenuImage = getTemplateIcon($sMenuImage);
                                    $sMenuImage = $this->getImage($sMenuImage);
 
                                    $sPartCaption = eval($aReplaced[$sPosition][$iKey]['Eval']);
                                }
 
                                if ($aReplaced[$sPosition][$iKey]['Bubble']) {
                                    $sCode  = str_replace('{iOldCount}', 0, $aReplaced[$sPosition][$iKey]['Bubble']);
                                    $sCode  = str_replace('{ID}', $memberID, $sCode);
 
                                    eval($sCode);
                                    $this -> sBubbles .= "\"{$aReplaced[$sPosition][$iKey]['Name']}\" : {count:'{$aRetEval['count']}'}, \n";
                                }
 
                                if ($isSkipItem)
                                    continue;
 
                                $sDescription = _t(!empty($aReplaced[$sPosition][$iKey]['Description']) ? $aReplaced[$sPosition][$iKey]['Description'] : $aReplaced[$sPosition][$iKey]['Caption']);
 
                                $aDefinedMenuItems[$sPosition][$iIndex] = array
                                (
                                    'ch_if:show_class'   => array(
                                        'condition' => !empty($sMenuClass),
                                        'content' => array(
                                            'class' => $sMenuClass
                                        )
                                    ),
 
                                    // primary link's info ;
                                    'menu_caption'       => $aReplaced[$sPosition][$iKey]['Name'] == 'MemberBlock'
                                                                    || $aReplaced[$sPosition][$iKey]['Caption'] == '{system}'
                                                                         ? $sPartCaption
                                                                         : null,
 
                                    'menu_link'          => $aReplaced[$sPosition][$iKey]['Script']
                                                                ? 'javascript:void(0)'
                                                                : $oPermalinks->permalink($aReplaced[$sPosition][$iKey]['Link']),
 
                                    'extended_action'    => $aReplaced[$sPosition][$iKey]['Script']
                                                                ? 'onclick="' . $aReplaced[$sPosition][$iKey]['Script'] . '"'
                                                                : null,
 
                                    'target'             => $aReplaced[$sPosition][$iKey]['Target'] == '_blank'
                                                                    ? 'target="_blank"'
                                                                    : null,
 
                                    'menu_image'         => $sMenuImage,
 
                                    'bubble_box'         => $aReplaced[$sPosition][$iKey]['Bubble']
                                                                ? $oSysTemplate -> parseHtmlByName( 'member_menu_bubble.html',
                                                                    array(
                                                                        'extra_styles' => ( $aRetEval['count'] ) ? null : 'style="display:none"',
                                                                        'count' => $aRetEval['count'],
                                                                        'bubble_id' => $this -> sBubblePrefix . $aReplaced[$sPosition][$iKey]['Name']))
                                                                : null,
 
                                    'indent'             => ( $this -> sMemberMenuPosition  == 'bottom' )  ? 'menu_item_bottom' : 'menu_item_top',
                                    'item_link_indent'   => ( $this -> sMemberMenuPosition  == 'bottom' )  ? 'bottom_indent' : 'top_indent',
 
                                    'menu_id' => $aReplaced[$sPosition][$iKey]['ID'],
 
                                    // menu description ;
                                    'ch_if:menu_desc' => array(
                                        'condition' => !empty($sDescription),
                                        'content'   => array (
                                           'menu_id'     => $aReplaced[$sPosition][$iKey]['ID'],
                                           'desc_window' => $this -> getDescriptionWindow($sDescription),
                                           'desc_indent' => ( $this -> sMemberMenuPosition  == 'bottom' ) ? 'description_bottom' : 'description_top',
                                        ),
                                    ),
                                );
 
                                if($aReplaced[$sPosition][$iKey]['Caption'] == '{system}') {
                                        $sPartCaption = _t($aReplaced[$sPosition][$iKey]['Description']);
                                }
 
                                // define top menu's popup section ;
                                $aContentKeys = array (
                                    'menu_id' => $aReplaced[$sPosition][$iKey]['ID'],
                                    'menu_name' => $aReplaced[$sPosition][$iKey]['Name'],
 
                                    // draw reduce element by top side ;
                                    'ch_if:reduce_element_top' => array (
                                        'condition' =>  ( $this -> sMemberMenuPosition  == 'bottom' ),
                                        'content'   => array (
                                            'menu_id'               => $aReplaced[$sPosition][$iKey]['ID'],
                                            'item_link'             => $aReplaced[$sPosition][$iKey]['Link'],
                                            'extended_action'       => empty($aReplaced[$sPosition][$iKey]['extended_action']) ? '' : $aReplaced[$sPosition][$iKey]['extended_action'],
                                            'cover'                 => 'top_cover',
                                            'item_name'             => $sPartCaption,
 
                                            'ch_if:part_image' => array(
                                                'condition' => ($sReduceImage),
                                                'content'   => array(
                                                    'item_img' => $this->getImage($sReduceImage, strip_tags($aReplaced[$sPosition][$iKey]['Caption'])),
                                                ),
                                            ),
                                        ),
                                    ),
 
                                    // draw reduce element by top side ;
                                    'ch_if:reduce_element_bottom' => array (
                                        'condition' =>  ( $this -> sMemberMenuPosition  == 'top' || $this -> sMemberMenuPosition  == 'static' ),
                                        'content'   => array (
                                            'menu_id'         => $aReplaced[$sPosition][$iKey]['ID'],
                                            'item_link'       => $aReplaced[$sPosition][$iKey]['Link'],
                                            'extended_action' => empty($aReplaced[$sPosition][$iKey]['extended_action']) ? '' : $aReplaced[$sPosition][$iKey]['extended_action'],
                                            'cover'           => 'bottom_cover',
                                            'item_name'       => $sPartCaption,
 
                                            'ch_if:part_image' => array(
                                                'condition' => ($sReduceImage),
                                                'content'   => array(
                                                    'item_img' => $this->getImage($sReduceImage, strip_tags($aReplaced[$sPosition][$iKey]['Caption'])),
                                                ),
                                            ),
                                        ),
                                    ),
                                );
 
                                if ( $aReplaced[$sPosition][$iKey]['PopupMenu'] ) {
                                    $aDefinedMenuItems[$sPosition][$iIndex]['menu_link']       = 'javascript:void(0)';
                                    $aDefinedMenuItems[$sPosition][$iIndex]['extended_action'] = null;
                                }
 
                                $aDefinedMenuItems[$sPosition][$iIndex]['ch_if:sub_menu'] = array (
                                    'condition'  => $aReplaced[$sPosition][$iKey]['PopupMenu'],
                                    'content'    =>  $aContentKeys,
                                );
 
                                $iIndex++;
                        }
                        //--
                    }
                }
 
                //generate cache file
                $aBubbles = array('bubbles' => $this -> sBubbles);
                $aDefinedMenuItems = array_merge($aDefinedMenuItems, $aBubbles);
                $oCache->setData( $this -> getCacheKey($aMemberInfo['ID'])
                    , $aDefinedMenuItems, $this -> iKeysFileTTL);
            }
            //--
 
            if (ChWsbRequest::serviceExists('pageac', 'menu_items_filter')) {
                ChWsbService::call('pageac', 'menu_items_filter', array('member', &$aDefinedMenuItems));
            }
 
            //define bubble list
            $sBubbleList = isset($aDefinedMenuItems['bubbles'])
                ? trim($aDefinedMenuItems['bubbles']) //get it from cache
                : trim($this -> sBubbles);
 
            //generate data
            $aTemplateKeys = array (
                'items' => $oSysTemplate->parseHtmlByName('extra_top_menu_items.html', array('ch_repeat:items' => $aDefinedMenuItems['top'])),
                'items_extra' => $oSysTemplate->parseHtmlByName('extra_top_menu_items.html', array('ch_repeat:items' => $aDefinedMenuItems['top_extra'])),
                'site_url' =>  CH_WSB_URL_ROOT,
                'menu_position' => $this -> sMemberMenuPosition,
                'is_profile_page' => defined('CH_PROFILE_PAGE') ? 'true' : 'false',
                'bubbles_list' => preg_replace('/,$/', '',  $sBubbleList),
                'bubbles_update_time' => $this -> iBubblesUpdateTime,
                'notify_destroy_time' => $this -> iNotifyDestroyTime,
                'page_reciver' => $this -> sQueryPageReciver,
                'bubble_prefix' => $this -> sBubblePrefix,
                'menu_popup_prefix' => $this->sMenuPopupPrefix,
                'description_prefix' => $this->sDescriptionPrefix
            );
 
            $oSysTemplate -> addJs('user_status.js');
            return $oSysTemplate -> parseHtmlByName('extra_top_menu.html', $aTemplateKeys);
        }
 
        function genMemberMenu($memberID = 0)
        {
            if (isset($GLOBALS['ch_profiler'])) $GLOBALS['ch_profiler']->beginMenu('Member Menu');
 
            // ** init some needed variables ;
 
            $aMemberInfo = array();
            $sOutputCode   = null;
            //--
 
            // if member's id was defined, that will receive all member's info ;
            if ($memberID) {
                $aMemberInfo  =  getProfileInfo($memberID);
                $aMemberInfo['ProfileLink'] = getProfileLink($aMemberInfo['ID']);
            }
 
            // if member not logged ;
            if (!$aMemberInfo) {
                if (isset($GLOBALS['ch_profiler'])) $GLOBALS['ch_profiler']->endMenu('Member Menu');
                return ;
            }
 
            // read data from cache file ;
               $oCache = $this -> getCacheObject();
               $aMenuStructure = $oCache->getData($GLOBALS['MySQL']->genDbCacheKey($this -> sMenuCacheFile));
               if(!$aMenuStructure) {
                   $aMenuStructure = $this -> createMemberMenuCache();
               }
 
            $sOutputCode = $this -> _parseStructure($aMemberInfo, $aMenuStructure);
 
            if (isset($GLOBALS['ch_profiler'])) $GLOBALS['ch_profiler']->endMenu('Member Menu');
 
            return $sOutputCode;
        }
 
        function getSubMenuContent( $iMemberId, $sSubMenuCode, $aLinkedItems = array() )
        {
            global $oFunctions;
 
            $iMemberId = (int) $iMemberId;
 
            $aMemberInfo  = getProfileInfo($iMemberId);
            $sSubMenuCode = eval( $oFunctions -> markerReplace( $aMemberInfo, $sSubMenuCode) );
 
            if($aLinkedItems) {
                foreach($aLinkedItems as $iKey => $aItems) {
                    $sSubMenuCode .= eval( $oFunctions -> markerReplace( $aMemberInfo, $aItems['code']) );
                }
            }
 
            return $sSubMenuCode;
        }
 
        function getCacheKey($iProfileId)
        {
            global $site;
 
            return $this -> sMenuMemberKeysCache . $iProfileId . '_' . md5($site['ver']
                . $site['build'] . $site['url'] . getCurrentLangName(false)
                . $GLOBALS['oSysTemplate']->getCode()) . '.php';
        }
 
        function deleteMemberMenuKeyFile($iProfile)
        {
            $oCache = $this -> getCacheObject();
            $oCache -> setData($this -> getCacheKey($iProfile), array(), $this -> iKeysFileTTL);
        }
 
        function deleteMemberMenuCaches()
        {
            //remove all member_menu_keys files
            $oCache = $this -> getCacheObject();
            $oCache->removeAllByPrefix($this -> sMenuMemberKeysCache);
 
            return $GLOBALS['MySQL']->cleanCache($this -> sMenuCacheFile);
        }
 
        function createMemberMenuCache()
        {
            $this -> deleteMemberMenuCaches();
 
            $oPermalink = new ChWsbPermalinks();
            $aCacheData = array();
 
            $sQuery = "SELECT * FROM `sys_menu_member` WHERE `Active` = '1' ORDER BY `Order`";
            $rResult = db_res($sQuery);
 
            while( true == ($aRow = $rResult->fetch()) ) {
                $aRow['Link'] = $oPermalink -> permalink($aRow['Link']);
                $aRow['linked_items'] = $this -> getLinkedItem($aRow['ID']);
 
                $aCacheData[$aRow['Position']][$aRow['ID']] = $aRow;
            }
 
            // if items not found ;
            if ( !$rResult->rowCount() ) {
                $aCacheData[$sMenuSection] = array();
            }
 
            $oCache = $this -> getCacheObject();
            if (!empty($aCacheData) && is_array($aCacheData)) {
                $oCache->setData ($GLOBALS['MySQL']->genDbCacheKey($this -> sMenuCacheFile), $aCacheData);
            }
 
            return $aCacheData;
        }
 
        function getLinkedItem($iMenuId)
        {
            $iMenuId = (int) $iMenuId;
            $sQuery  = "SELECT `Eval` FROM `sys_menu_member` WHERE `Parent` = {$iMenuId} AND `Type` = 'linked_item'";
            $rResult = db_res($sQuery);
 
            $aLinkedItems = array();
            while ( true == ($aRow = $rResult->fetch()) ) {
                $aLinkedItems[] = array(
                    'code' => $aRow['Eval']
                );
            }
 
            return $aLinkedItems;
        }
 
        function getImage($sImg, $sAlt = '', $sAttr = '')
        {
            return $GLOBALS['oFunctions']->sysImage($sImg, '', $sAlt, $sAttr);
        }
 
    }