WB 2.08.x

<?php

/**

 *

 * @category        module

 * @package         show_menu2

 * @author          WebsiteBaker Project

 * @copyright       2009-2013, WebsiteBaker Org. e.V.

 * @link            http://www.websitebaker.org/

 * @platform        WebsiteBaker 2.7.0 | 2.8.x

 *

 */

if(defined('WB_PATH') == false) { die("Cannot access this file directly"); }

 * future replacement for the function show_menu2()

 */

class SM2

{

    const ROOT =          -1000;

    const CURR =          -2000;

    const ALLMENU =          -1;

    const START =          1000;

    const MAX =            2000;

    const ALL =          0x0001; // bit 0 (group 1) (Note: also used for max level!)

    const TRIM =         0x0002; // bit 1 (group 1)

    const CRUMB =        0x0004; // bit 2 (group 1)

    const SIBLING =      0x0008; // bit 3 (group 1)

    const NUMCLASS =     0x0010; // bit 4

    const ALLINFO =      0x0020; // bit 5

    const NOCACHE =      0x0040; // bit 6

    const PRETTY =       0x0080; // bit 7

    const ESCAPE =       0x0100; // bit 8

    const NOESCAPE =          0; // NOOP, unnecessary with WB 2.6.7+

    const SHOWHIDDEN =   0x0800; // bit 11

    const XHTML_STRICT = 0x1000; // bit 12

    const NO_TITLE =     0x2000; // bit 13

    const _GROUP_1 =     0x000F; // exactly one flag from group 1 is required

    const CONDITIONAL =  'if\s*\(([^\)]+)\)\s*{([^}]*)}\s*(?:else\s*{([^}]*)}\s*)?';

    const COND_TERM =    '\s*(\w+)\s*(<|<=|==|=|=>|>|!=)\s*([\w\-]+)\s*';

}

// Implement support for page_menu and show_menu using show_menu2. If you remove

// the comments characters from the beginning of the following include, all menu

// functions in Website Baker will be implemented using show_menu2. While it is

// commented out, the original WB functions will be used.

//include('legacy.php');

// create your own formatter class and pass the object into show_menu2

{

    var $output;

    var $flags;

    var $itemOpen;

    var $itemClose;

    var $menuOpen;

    var $menuClose;

    var $topItemOpen;

    var $topMenuOpen;

    var $page;

    var $url;

    var $currSib;

    var $sibCount;

    var $currClass;

    var $prettyLevel;

    // output the data

    function output($aString) {

            echo $aString;

        } else {

        }

    }

    function set($aFlags, $aItemOpen, $aItemClose, $aMenuOpen, $aMenuClose, $aTopItemOpen, $aTopMenuOpen) {

        $this->flags        = $aFlags;

        $this->itemOpen     = is_string($aItemOpen)    ? $aItemOpen    : '[li][a][menu_title]</a>';

        $this->itemClose    = is_string($aItemClose)   ? $aItemClose   : '</li>';

        $this->menuOpen     = is_string($aMenuOpen)    ? $aMenuOpen    : '[ul]';

        $this->menuClose    = is_string($aMenuClose)   ? $aMenuClose   : '</ul>';

        $this->topItemOpen  = is_string($aTopItemOpen) ? $aTopItemOpen : $this->itemOpen;

        $this->topMenuOpen  = is_string($aTopMenuOpen) ? $aTopMenuOpen : $this->menuOpen;

    }

    // initialize the state of the formatter before anything is output

    function initialize() {

        $this->output = '';

        $this->prettyLevel = 0;

        }

    }

        $currClass = '';

        $currItem = $this->menuOpen;

        if ($this->topMenuOpen) {

            $currItem = $this->topMenuOpen;

            $currClass .= ' menu-top';

            $this->topMenuOpen = false;

        }

        }

                $this->format($aPage, $aUrl, $currItem, $currClass));

        }

        else {

            $this->output($this->format($aPage, $aUrl, $currItem, $currClass));

        }

    }

    function startItem(&$aPage, &$aUrl, $aCurrSib, $aSibCount) {

        // generate our class list

        $currClass = '';

        }

        if (array_key_exists('sm2_has_child', $aPage)) {

            // not set if false, so existence = true

            $currClass .= ' menu-expand';

        }

        }

            $currClass .= ' menu-parent';

        }

        elseif (array_key_exists('sm2_is_sibling', $aPage)) {

            // not set if false, so existence = true

            $currClass .= ' menu-sibling';

        }

        elseif (array_key_exists('sm2_child_level',$aPage)) {

            // not set if not a child

            $currClass .= ' menu-child';

            }

        }

        if ($aCurrSib == 1) {

            $currClass .= ' menu-first';

        }

        if ($aCurrSib == $aSibCount) {

            $currClass .= ' menu-last';

        }

        // use the top level item if this is the first item

        $currItem = $this->itemOpen;

        if ($this->topItemOpen) {

            $currItem = $this->topItemOpen;

            $this->topItemOpen = false;

        }

        // replace all keywords in the output

        }

        $this->output($this->format($aPage, $aUrl, $currItem, $currClass, $aCurrSib, $aSibCount));

    }

        $aCurrSib = 0, $aSibCount = 0)

        $this->page      = &$aPage;

        $this->url       = &$aUrl;

        $this->currClass = trim($aCurrClass);

        $this->currSib   = $aCurrSib;

        $this->sibCount  = $aSibCount;

        unset($this->url);

        unset($this->currClass);

    }

    function format2(&$aCurrItem) {

        if (!is_string($aCurrItem)) return '';

                'a|ac|/a|li|/li|ul|/ul|menu_title|menu_icon_0|menu_icon_1|'.

            array($this, 'replace'),

            $aCurrItem);

        $aMatch = $aMatches[1];

        switch ($aMatch) {

        case 'a':

        case 'ac':

            if( substr($retval, 0, 2) != '<a'){

                $retval = '<a href="'.$this->url.'" class="'.$this->currClass.'"';

            }

            if(($this->flags & SM2::NO_TITLE)) {

                $retval .= ' title="'.$this->page['tooltip'].'"';

            }

            if(!($this->flags & SM2::XHTML_STRICT)) {

                $retval .= ' target="'.$this->page['target'].'"';

            }

            $retval .= '>';

            break;

            $retval = '</a>'; break;

        case 'li':

            $retval = '<li class="'.$this->currClass.'">'; break;

        case '/li':

            $retval = '</li>'; break;

        case 'ul':

            $retval = '<ul class="'.$this->currClass.'">'; break;

        case '/ul':

            $retval = '</ul>'; break;

        case 'url':

            $retval = $this->url; break;

        case 'sib':

            $retval = $this->currSib; break;

        case 'sibCount':

            $retval = $this->sibCount; break;

        case 'class':

            $retval = $this->currClass; break;

        default:

            if (array_key_exists($aMatch, $this->page)) {

                }

                else {

                    $retval = $this->page[$aMatch];

                }

            }

            }

        }

        return $retval;

    }

    function replaceIf(&$aExpression, &$aIfValue, &$aElseValue) {

        // evaluate all of the tests in the conditional (we don't do short-circuit

        // evaluation) and replace the string test with the boolean result

        $rgTests = preg_split('/(\|\||\&\&)/', $aExpression, -1, PREG_SPLIT_DELIM_CAPTURE);

        for ($n = 0; $n < count($rgTests); $n += 2) {

            }

            else {

                @error_logs("show_menu2 error: conditional expression is invalid!");

                $rgTests[$n] = false;

            }

        }

        // combine all test results for a final result

        $ok = $rgTests[0];

        for ($n = 1; $n+1 < count($rgTests); $n += 2) {

            if ($rgTests[$n] == '||') {

                $ok = $ok || $rgTests[$n+1];

            }

            else {

                $ok = $ok && $rgTests[$n+1];

            }

        }

        return $ok ? $this->format2($aIfValue) : $this->format2($aElseValue);

    }

    // conditional test

    function ifTest(&$aKey, &$aOperator, &$aValue) {

        global $wb;

        $operand = false;

        switch($aKey) {

        case 'class':

            // we need to wrap the class names in spaces so we can test for a unique

            // class name that will not match prefixes or suffixes. Same must be done

            // for the value we are testing.

            $operand = $this->page['target'];

            break;

            $operand = $this->currSib;

            if ($aValue == 'sibCount') {

                $aValue = $this->sibCount;

            }

            break;

        case 'sibCount':

            $operand = $this->sibCount;

            break;

        case 'level':

            $operand = $this->page['level'];

            switch ($aValue) {

            case 'root':    $aValue = 0; break;

            case 'granny':  $aValue = $wb->page['level']-2; break;

            case 'parent':  $aValue = $wb->page['level']-1; break;

            case 'current': $aValue = $wb->page['level'];   break;

            case 'child':   $aValue = $wb->page['level']+1; break;

            }

            if ($aValue < 0) $aValue = 0;

            break;

        case 'id':

            $operand = $this->page['page_id'];

            switch ($aValue) {

            case 'parent':  $aValue = $wb->page['parent'];  break;

            case 'current': $aValue = $wb->page['page_id']; break;

            }

            break;

        default:

            return '';

        }

        case '<=':

        case '=':

        case '==':

        case '!=':

            if ($aKey == 'class') {

                $ok = strstr($operand, " $aValue ") !== FALSE;

            }

            else {

            if ($aOperator == '!=') {

                $ok = !$ok;

            }

            break;

        case '>=':

    }

    function finishItem() {

        }

        else {

            $this->output($this->itemClose);

        }

    }

    // finish the current menu

    function finishList() {

        $this->prettyLevel -= 3;

        if ($this->flags & SM2::PRETTY) {

        }

        else {

            $this->output($this->menuClose);

        }

    }

    function finalize() {

        }

    }

    // return the output

    function getOutput() {

        return $this->output;

    }

};

function error_logs($error_str)

{

                $log_error = true;

                if ( ! function_exists('error_log') )

                        $log_error = false;

                $log_file = @ini_get('error_log');

                if ( !empty($log_file) && ('syslog' != $log_file) && !@is_writable($log_file) )

                        $log_error = false;

                if ( $log_error )

                        @error_log($error_str, 0);

}

function show_menu2(

    $aMenu          = 0,

    $aMaxLevel      = -1999, // SM2::CURR+1

    $aOptions       = SM2::TRIM,

    $aItemClose     = false,

    $aMenuOpen      = false,

    $aMenuClose     = false,

    $aTopItemOpen   = false,

    $aTopMenuOpen   = false

    )

{

    global $wb;

    $flags = 0;

    if (is_int($aOptions)) {

        $flags = $aOptions;

        $aOptions = array();

    }

    else if (isset($aOptions['flags'])) {

        $flags = $aOptions['flags'];

    }

    else {

        @error_logs('show_menu2 error: $aOptions is invalid. No flags supplied!');

    }

    // we do ensure that they provide at least one.

    // search page results don't have any of the page data loaded by WB, so we load it

    $CURR_PAGE_ID = defined('REFERRER_ID') ? REFERRER_ID : PAGE_ID;

    if (count($wb->page) == 0 && defined('REFERRER_ID') && REFERRER_ID > 0) {

        global $database;

        $sql = 'SELECT * FROM `'.TABLE_PREFIX.'pages` WHERE `page_id` = '.REFERRER_ID.'';

        $result = $database->query($sql);

        if ($result->numRows() == 1) {

            $wb->page = $result->fetchRow();

        }

        unset($result);

    }

    // of the current page if no menu has been supplied

    if ($aMenu == 0) {

        $aMenu = $wb->page['menu'] == '' ? 1 : $wb->page['menu'];

    // Set some of the $wb->page[] settings to defaults if not set

    $pageLevel  = $wb->page['level']  == '' ? 0 : $wb->page['level'];

    $pageParent = $wb->page['parent'] == '' ? 0 : $wb->page['parent'];

    // handle the special values that can be passed in as $aStart

    $aStartLevel = 0;

        if ($aStart == SM2::CURR) {

            $aStart = $pageParent;

        }

        else {

            $aStart = $CURR_PAGE_ID;

    }

        $aStartLevel = $aStart - SM2::ROOT;

    }

    // multiple calls to show_menu2 in a single page with only a single call to

    // of the information and processed it, so we don't need to do it again.

        global $database;

        // create an array of all parents of the current page. As the page_trail

        // doesn't include the theoretical root element 0, we add it ourselves.

        $rgCurrParents = explode(",", '0,'.$wb->page['page_trail']);

        array_pop($rgCurrParents); // remove the current page

        $rgParent = array();

        // if the caller wants all menus gathered together (e.g. for a sitemap)

        // then we don't limit our SQL query

        $menuLimitSql = ' AND `menu`='.$aMenu;

        }

        // we only load the description and keywords if we have been told to,

        // this cuts the memory load for pages that don't use them. Note that if

        // we haven't been told to load these fields the *FIRST TIME* show_menu2

        // is called (i.e. where the database is loaded) then the info won't

        // exist anyhow.

        $fields  = '`parent`,`page_id`,`menu_title`,`page_title`,`link`,`target`,';

        $fields .= '`menu_icon_0`,`menu_icon_1`,`page_icon`,`tooltip`';

        if ($flags & SM2::ALLINFO) {

        }

        // we request all matching rows from the database for the menu that we

        // are about to create it is cheaper for us to get everything we need

        // multiple calls to the database.

        $sql .= 'ORDER BY `level` ASC, `position` ASC';

        $oRowset = $database->query($sql);

        if (is_object($oRowset) && $oRowset->numRows() > 0) {

            while ($page = $oRowset->fetchRow()) {

                // ignore all pages that the current user is not permitted to view

                if(version_compare(WB_VERSION, '2.7', '>=')) { // WB >= 2.7

                    // 1. hidden pages aren't shown unless they are on the current page

                    if ($page['visibility'] == 'hidden') {

                        $page['sm2_hide'] = true;

                    }

                    else if (!$wb->page_is_active($page) && $page['link'] != $wb->default_link && !INTRO_PAGE) {

                        continue;

                    }

                    // 3. all pages not visible to this user (unless always visible to registered users) are ignored

                    else if (!$wb->page_is_visible($page) && $page['visibility'] != 'registered') {

                        continue;

                    }

                }

                    $page['page_icon'] = WB_URL.$page['page_icon'];

                }

                if(isset($page['menu_icon_0']) && $page['menu_icon_0'] != '') {

                    $page['menu_icon_0'] = WB_URL.$page['menu_icon_0'];

                }

                if(isset($page['menu_icon_1']) && $page['menu_icon_1'] != '') {

                    $page['menu_icon_1'] = WB_URL.$page['menu_icon_1'];

                }

                $idx = $page['parent'];

                if (!array_key_exists($idx, $rgParent)) {

                    $rgParent[$idx] = array();

                }

                // mark our current page as being on the current path

                if ($page['page_id'] == $CURR_PAGE_ID) {

                    $page['sm2_is_curr'] = true;

                    $page['sm2_on_curr_path'] = true;

                    {

                }

                // mark parents of the current page as such

                if (in_array($page['page_id'], $rgCurrParents)) {

                    $page['sm2_is_parent'] = true;

                    $page['sm2_on_curr_path'] = true;

                    {

                }

                // add the entry to the array

            }

        // mark all elements that are siblings of any element on the current path

        foreach ($rgCurrParents as $x) {

            if (array_key_exists($x, $rgParent)) {

                foreach (array_keys($rgParent[$x]) as $y) {

                    $mark =& $rgParent[$x][$y];

                    $mark['sm2_path_sibling'] = true;

                    unset($mark);

                }

            }

        }

        // mark all elements that have children and are siblings of the current page

        $parentId = $pageParent;

        foreach (array_keys($rgParent) as $x) {

            $childSet =& $rgParent[$x];

            foreach (array_keys($childSet) as $y) {

                $mark =& $childSet[$y];

                if (array_key_exists($mark['page_id'], $rgParent)) {

                    $mark['sm2_has_child'] = true;

                }

                if ($mark['parent'] == $parentId && $mark['page_id'] != $CURR_PAGE_ID) {

                    $mark['sm2_is_sibling'] = true;

                }

                unset($mark);

            }

            unset($childSet);

        }

        // mark all children of the current page. We don't do this when

        // $CURR_PAGE_ID is 0, as 0 is the parent of everything.

        // when no referrer is available.s

        if ($CURR_PAGE_ID != 0) {

            sm2_mark_children($rgParent, $CURR_PAGE_ID, 1);

        }