Menu.php

Go to the documentation of this file.

<?php
// {{{ license

// +----------------------------------------------------------------------+
// | FastFrame Application Framework                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 2002-2006 The Codejanitor Group                        |
// +----------------------------------------------------------------------+
// | This source file is subject to the GNU Lesser Public License (LGPL), |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.fsf.org/copyleft/lesser.html                              |
// | If you did not receive a copy of the LGPL and are unable to          |
// | obtain it through the world-wide-web, you can get it by writing the  |
// | Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
// | MA 02111-1307, USA.                                                  |
// +----------------------------------------------------------------------+
// | Authors: Jason Rust <jrust@codejanitor.com>                          |
// +----------------------------------------------------------------------+

// }}}
// {{{ requires 

require_once dirname(__FILE__) . '/Output.php';

// }}}
// {{{ class FF_Menu

// }}}
class FF_Menu {
    // {{{ properties

    var $o_registry;

    var $o_output;

    var $o_fileCache;

    var $cacheFile;

    var $menuVariables; 

    var $menuType;

    var $currentAppPlaceholder = '%currentApp%';

    var $debug = false;

    // }}}
    // {{{ constructor()

    function FF_Menu($in_type)
    {
        $this->o_registry =& FF_Registry::singleton();
        $this->o_output =& FF_Output::factory();
        $this->o_fileCache =& FF_FileCache::singleton();
        $this->menuType = $in_type;
        $this->_setCacheFile();
    }

    // }}}
    // {{{ factory()

    function &factory($in_type)
    {
        static $a_instances;
        if (!isset($a_instances)) {
            $a_instances = array();
        }

        $s_class = 'FF_Menu_' . $in_type;
        if (!isset($a_instances[$s_class])) {
            $pth_menu = dirname(__FILE__) . '/Menu/' . $in_type . '.php';
            if (file_exists($pth_menu)) { 
                require_once $pth_menu;
                $a_instances[$s_class] = new $s_class($in_type);
            } 
            else {
                trigger_error("Invalid menu type: $in_type", E_USER_ERROR); 
            }
        }

        return $a_instances[$s_class];
    }

    // }}}
    // {{{ renderMenu()

    function renderMenu()
    {
        // interface
    }

    // }}}
    // {{{ _isMenuCached()

    function _isMenuCached()
    {
        list($s_subdir, $s_name) = explode('/', $this->cacheFile);
        if (!file_exists(($pth_file = $this->o_fileCache->getPath(array('subdir' => $s_subdir, 'name' => $s_name))))) {
            return false;
        }
        else {
            $s_cacheMTime = filemtime($pth_file);
        }

        // Changing an app setting, such as whether it is enabled can change the menu
        if (filemtime($this->o_registry->getRootFile('apps.php', 'config')) > $s_cacheMTime) {
            return false;
        }

        // See if any of the menu files have been updated
        foreach ($this->o_registry->getApps() as $s_app) {
            // Make sure this app is enabled 
            if ($this->o_registry->getAppParam('status', 'disabled', $s_app) != 'enabled') {
                continue;
            }
                
            $pth_menu = $this->o_registry->getAppFile($this->_getMenuFilename($s_app), $s_app, 'config');
            if (file_exists($pth_menu) && (filemtime($pth_menu) > $s_cacheMTime)) {
                return false;
            }
        }

        return true;
    }

    // }}}
    // {{{ _getCachedMenu()

    function _getCachedMenu()
    {
        require_once dirname(__FILE__) . '/Perms.php';
        $o_perms =& FF_Perms::factory();
        $o_registry =& FF_Registry::singleton();
        $o_output =& FF_Output::factory();
        ob_start();
        list($s_subdir, $s_name) = explode('/', $this->cacheFile);
        require_once $this->o_fileCache->getPath(array('subdir' => $s_subdir, 'name' => $s_name));
        $s_data = ob_get_contents();
        ob_end_clean();
        return $s_data;
    }

    // }}}
    // {{{ _getMenuFilename()

    function _getMenuFilename($in_app)
    {
        // Get the profile specific application menu
        if ($this->o_registry->getAppParam('profile', false, $in_app)) {
            return sprintf('%s/menu.php', 
                    $this->o_registry->getAppParam('profile', null, $in_app));
        }
        else {
            return 'menu.php';
        }
    }

    // }}}
    // {{{ _importMenuVars()

    function _importMenuVars()
    {
        // First just loop and include all actions so all apps can link to other apps
        foreach ($this->o_registry->getApps() as $s_app) {
            // Include any additional action IDs this app has
            $pth_actions = $this->o_registry->getAppFile('ActionHandler/actions.php', $s_app, 'libs');
            if (file_exists($pth_actions)) {
                require_once $pth_actions;
            }
        }

        if ($this->o_registry->getConfigParam('display/home_link')) {
            // Add the home link which takes the user to their default page
            $a_appMenu = array();
            $a_appMenu[] = array(
                'contents' => _('Home'),
                'icon' => 'mini/home.gif',
                'urlParams' => array('actionId' => ACTION_HOME, 'module' => ''));
            $this->menuVariables = array(array('app' => '', 'vars' => $a_appMenu));
        }
        else {
            $this->menuVariables = array();
        }

        // Now loop through enabled apps and get the menu variables
        foreach ($this->o_registry->getApps() as $s_app) {
            // Make sure this app is enabled 
            if ($this->o_registry->getAppParam('status', 'disabled', $s_app) != 'enabled') {
                continue;
            }

            $pth_menu = $this->o_registry->getAppFile($this->_getMenuFilename($s_app), $s_app, 'config');
            if (file_exists($pth_menu)) {
                $a_appMenu = null; 
                require $pth_menu;
                if (is_array($a_appMenu) && isset($a_appMenu[0])) {
                    $this->menuVariables[] = array(
                        'app' => $s_app,
                        'vars' => $a_appMenu,
                    );
                }
                else {
                    return trigger_error('The menu file ' . basename($pth_menu) . ' for the ' . $s_app . ' application is not configured correctly.', E_USER_WARNING);
                }
            }
        }
    }

    // }}}
    // {{{ _processPerms()

    function _processPerms($in_data, $in_node)
    {
        $a_ifStatements = array();
        // Possible options for visibility are guest_only, logged_in, and always
        $in_data['visibility'] = isset($in_data['visibility']) ? $in_data['visibility'] : 'logged_in';
        if ($in_data['visibility'] == 'guest_only') {
            $a_ifStatements[] = 'FF_Auth::isGuest()';
        }
        elseif ($in_data['visibility'] == 'logged_in') {
            $a_ifStatements[] = '!FF_Auth::isGuest()';
        }

        if (isset($in_data['perms'])) {
            $s_permsCall = '$o_perms->hasPerm(';
            if (is_array($in_data['perms'])) {
                $s_app = isset($in_data['perms']['app']) ? $in_data['perms']['app'] : $this->currentAppPlaceholder;
                unset($in_data['perms']['app']);
                $s_permsList = '\'' . implode($in_data['perms'], '\',\'') . '\'';
                // first argument is list of perms to check, second is the app
                $s_permsCall .= 'array(' . $s_permsList . '),\'' . $s_app . '\'';
            }
            else {
                // If a string then that is the perm to check
                $s_permsCall .= '\'' . $in_data['perms'] . '\',\'' . $this->currentAppPlaceholder . '\'';
            }

            $s_permsCall .= ')';
            $a_ifStatements[] = $s_permsCall;
        }

        if (count($a_ifStatements) != 0) {
            $tmp_nl = $this->debug ? "\n" : ' '; 
            $in_node = "$tmp_nl<?php if (" . implode(' && ', $a_ifStatements) . ") { ?>$tmp_nl$in_node$tmp_nl<?php } ?>$tmp_nl";
        }

        return $in_node;
    }

    // }}}
    // {{{ _processApps()

    function _processApps($in_data, $in_node)
    {

        if (isset($in_data['app_private']) && $in_data['app_private'] == true) {
            $tmp_nl = $this->debug ? "\n" : ' '; 
            $s_appCheck = '$o_registry->getCurrentApp() == \'' . $this->currentAppPlaceholder .  '\'';
            $in_node = "$tmp_nl<?php if ($s_appCheck) { ?>$tmp_nl$in_node$tmp_nl<?php } ?>$tmp_nl";
        }

        return $in_node;
    }

    // }}}
    // {{{ _replaceAppPlaceholder()

    function _replaceAppPlaceholder($in_app, $in_data)
    {
        // Since the placeholder is used in the url, the placeholder can be urlencoded 
        static $s_holder;
        if (!isset($s_holder)) {
            $s_holder = urlencode($this->currentAppPlaceholder);
        }

        $in_data = str_replace($s_holder, $in_app, $in_data);
        $in_data = str_replace($this->currentAppPlaceholder, $in_app, $in_data);
        return $in_data;
    }

    // }}}
    // {{{ _getLinkUrl()

    function _getLinkUrl($in_url, $in_sessionInTags)
    {
        if (is_array($in_url)) {
            if (!isset($in_url['app'])) {
                $in_url['app'] = $this->currentAppPlaceholder;
            }

            // Always want session to be on url in case someone has cookies off
            $in_url[session_name()] = session_id();
            $s_url = FastFrame::url('index.php', $in_url);
            // Can't have the current session id in the url
            if ($in_sessionInTags) {
                $tmp_repl = '<?php echo SID; ?>';
            }
            else {
                $tmp_repl = '\' . SID . \'';
            }

            $s_url = preg_replace('/' . session_name() . '=.*?(&|$)/S', "$tmp_repl\\1", $s_url);
            return $s_url;
        }
        else {
            return $in_url;
        }
    }

    // }}}
    // {{{ _formatMenuNodeData()

    function _formatMenuNodeData($in_data, $in_sessionInTags)
    {
        $in_data['contents'] = isset($in_data['contents']) ? 
            addcslashes($in_data['contents'], '\'') : '';
        $in_data['statusText'] = isset($in_data['statusText']) ? 
            $in_data['statusText'] : $in_data['contents'];
        $in_data['icon'] = isset($in_data['icon']) ? 
            addcslashes($this->o_output->imgTag($in_data['icon'], 'none', array('align' => 'bottom')), '\'') . ' ' : '';
        $in_data['target'] = isset($in_data['target']) ? $in_data['target'] : '_self';
        $in_data['urlParams'] = isset($in_data['urlParams']) ? 
            $this->_getLinkUrl($in_data['urlParams'], $in_sessionInTags) : '';

        return $in_data;
    }

    // }}}
    // {{{ _setCacheFile()

    function _setCacheFile()
    {
        $this->cacheFile = 'menu/' . $this->menuType . '.php';
    }

    // }}}
}
?>

---