Source for file menu.php

Documentation is available at menu.php

  1. <?php
  2. /**
  3. * Main menu for admin and normal users
  4. *
  5. * @author    Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage Misc
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. /** permission codes */
  18. require_once 'inc/permissions.php';
  19.  
  20. /**
  21. * Main menu for admin and normal users
  22. *
  23. * @package    Bumblebee
  24. * @subpackage Misc
  25. * @todo //TODO: combine the data storage with action.php for cleaner implementation
  26. */
  27. class UserMenu {
  28.   /**
  29.   * list of available actions
  30.   * @var ActionListing 
  31.   */
  32.   var $actionListing;
  33.   /**
  34.   * text output before start of menu block
  35.   * @var string 
  36.   */
  37.   var $menuPrologue   = '';
  38.   /**
  39.   * text output after end of menu block
  40.   * @var string 
  41.   */
  42.   var $menuEpilogue   = '';
  43.   /**
  44.   * html id for the enclosing DIV
  45.   * @var string 
  46.   */
  47.   var $menuDivId      = 'menulist';
  48.   /**
  49.   * html start-tag for the menu section
  50.   * @var string 
  51.   */
  52.   var $menuStart      = '<ul>';
  53.   /**
  54.   * html menu entry (complete!) for the link to the online help
  55.   * @var string 
  56.   */
  57.   var $menuHelp;
  58.   /**
  59.   * html stop-tag for the menu section
  60.   * @var string 
  61.   */
  62.   var $menuStop       = '</ul>';
  63.   /**
  64.   * html start-tag for each menu entry
  65.   * @var string 
  66.   */
  67.   var $itemStart      = '<li>';
  68.   /**
  69.   * html stop-tag for each menu entry
  70.   * @var string 
  71.   */
  72.   var $itemStop       = '</li>';
  73.   /**
  74.   * html id for div that alerts to current Masquerade setting
  75.   * @var string 
  76.   */
  77.   var $masqDivId      = 'masquerade';
  78.   /**
  79.   * html start-tag for each menu section
  80.   * @var string 
  81.   */
  82.   var $headerStart    = '<li class="menuSection">';
  83.   /**
  84.   * html stop-tag for each menu section
  85.   * @var string 
  86.   */
  87.   var $headerStop     = '</li>';
  88.   /**
  89.   * text to include at start of main menu section
  90.   * @var string 
  91.   */
  92.   var $mainMenuHeader;
  93.   /**
  94.   * text to include at start of admin menu section
  95.   * @var string 
  96.   */
  97.   var $adminHeader;
  98.   /**
  99.   * tag to use for the masq alert style (be careful of using div in an ul!)
  100.   * @var string 
  101.   */
  102.   var $masqAlertTag  = 'li';
  103.   /**
  104.   * display the menu
  105.   * @var boolean 
  106.   */
  107.   var $showMenu       = true;
  108.  
  109.   /**
  110.   * logged in user's credentials
  111.   * @var BumblebeeAuth 
  112.   */
  113.   var $_auth;
  114.   /**
  115.   * currently selected action
  116.   * @var string 
  117.   */
  118.   var $_verb;
  119.  
  120.   /**
  121.   * Constructor
  122.   * @param BumblebeeAuth $auth  user's credentials
  123.   * @param string        $verb  current action
  124.   */
  125.   function UserMenu($auth, $verb) {
  126.     $this->_auth = $auth;
  127.     $this->_verb = $verb;
  128.     $this->menuHelp       = '<li class="last"><a href="http://bumblebeeman.sf.net/docs?section=__section__&amp;version=__version__">' . T_('Help') . '</a></li>';
  129.     $this->mainMenuHeader = T_('Main Menu');
  130.     $this->adminHeader    = T_('Administration');
  131.   }
  132.  
  133.   /**
  134.   * Generates an html representation of the menu
  135.   * @return string       menu in html format
  136.   */
  137.   function getMenu() {
  138.     if (! $this->showMenu) {
  139.       return '';
  140.     }
  141.     $menu  = '<div'.($this->menuDivId ? ' id="'.$this->menuDivId.'"' :'' ).'>';
  142.     $menu .= $this->menuStart;
  143.     $menu .= $this->_constructMenuEntries();
  144.     if ($this->_auth->amMasqed() && $this->_verb != 'masquerade')
  145.           $menu .= $this->_getMasqAlert();
  146.     $menu .= $this->_getHelpMenu();
  147.     $menu .= $this->menuStop;
  148.     $menu .= '</div>';
  149.     return $menu;
  150.   }
  151.  
  152.   /**
  153.   * Generates an html representation of the menu according to the current user's permissions
  154.   * @return string       menu in html format
  155.   */
  156.   function _constructMenuEntries() {
  157.     $t = '';
  158.     if ($this->mainMenuHeader) {
  159.       $t .= $this->headerStart.$this->mainMenuHeader.$this->headerStop;
  160.     }
  161.     $first_admin = true;
  162.     #preDump($this->actionListing->actions);
  163.     foreach ($this->actionListing->actions as $action) {
  164.       #print $action->name()."<br />\n";
  165.       #print $action->name(). " requires " . $action->permissions() . " have " .$this->_auth->system_permissions."<br />\n";
  166.       if ($action->menu_visible() && $this->_auth->permitted($action->permissions())) {
  167.         #print " visible";
  168.         if ($first_admin && $action->requires_admin()) {
  169.           #print " admin header";
  170.           $first_admin = false;
  171.           if ($this->adminHeader) {
  172.             $t .= $this->headerStart.$this->adminHeader.$this->headerStop;
  173.           }
  174.         }
  175.         $t .= $this->itemStart
  176.               .'<a href="'.makeURL($action->name()).'">'.$action->menu().'</a>'
  177.             .$this->itemStop;
  178.       }
  179.       #print "<br/>";
  180.     }
  181.     return $t;
  182.   }
  183.  
  184.   /**
  185.   * Generates an html div to alert the user that masquerading is in action
  186.   * @return string       menu in html format
  187.   */
  188.   function _getMasqAlert() {
  189.     $t = '<'.$this->masqAlertTag.' id="'.$this->masqDivId.'">'
  190.              .'Mask: '.xssqw($this->_auth->eusername)
  191.              .' (<a href="'.makeURL('masquerade', array('id'=>-1)).'">end</a>)'
  192.         .'</'.$this->masqAlertTag.'>';
  193.     return $t;
  194.   }
  195.  
  196.   /**
  197.   * Generates an html snippet to for the link to the online help
  198.   * @return string       menu in html format
  199.   * @global string       version of the Bumblebee installation (can serve different versions if necessary)
  200.   */
  201.   function _getHelpMenu() {
  202.     global $BUMBLEBEEVERSION;
  203.     $help = $this->menuHelp;
  204.     $help = preg_replace(array('/__version__/',   '/__section__/'),
  205.                          array($BUMBLEBEEVERSION, $this->_verb),
  206.                          $help);
  207.     return $help;
  208.   }
  209.  
  210. } // class UserMenu
  211.  
  212.  
  213. /**
  214. * create a URL for an anchor
  215. * @param string  $action    action to be performed
  216. * @param array   $list      (optional) key => value data to be added to the URL
  217. * @param boolean $escape    use &amp; rather than & in the URL
  218. * @return string URL
  219. */
  220. function makeURL($action=NULL, $list=NULL, $escape=true) {
  221.   $conf = ConfigReader::getInstance();
  222.   $list = is_array($list) ? $list : array();
  223.   if ($action !== NULL) $list['action'] = $action;
  224.   $args = array();
  225.   foreach ($list as $field => $value) {
  226.     if (is_array($value)) $value = join(',', $value);
  227.     $args[] = $field.'='.urlencode($value);
  228.   }
  229.   $delim = $escape ? '&amp;' : '&';
  230.   if (count($args) > 0) return $conf->BaseURL.'?'.join($delim, $args);
  231.  
  232.   return $conf->BaseURL;
  233. }
  234.  
  235.  
  236. /**
  237. * Create an absolute URL for an anchor (include protocol and port)
  238. *
  239. * @param mixed   $target 
  240. * @param array   $list      (optional) key => value data to be added to the URL
  241. * @param boolean $escape    use &amp; rather than & in the URL
  242. * @return  string  Absolute URL
  243. */
  244. function makeAbsURL($target=NULL, $escape=true) {
  245.  
  246.   if (isset($_SERVER['HTTPS']) && !strcasecmp($_SERVER['HTTPS'], 'on')) {
  247.     $protocol = 'https';
  248.   } else {
  249.     $protocol = 'http';
  250.   }
  251.  
  252.   $port = isset($_SERVER['SERVER_PORT']) ? $_SERVER['SERVER_PORT'] : 80;
  253.  
  254.   // filter out well known ports from the URL
  255.   if (($protocol == 'http' && $port == 80) || ($protocol == 'https' && $port == 443)) {
  256.     unset($port);
  257.   }
  258.  
  259.   $host = $_SERVER['SERVER_NAME'];
  260.   if (empty($host)) {
  261.     list($host) = explode(':', $_SERVER['HTTP_HOST']);
  262.   }
  263.  
  264.   $serverPart = $protocol .'://'. $host . (isset($port) ? ':'. $port : '');
  265.  
  266.   if (is_array($target) || $target === NULL) {
  267.     $pathPart = makeURL($target[0], $target[1], $escape);
  268.   } else {
  269.     $conf = ConfigReader::getInstance();
  270.     $pathPart = $conf->BasePath . $target;
  271.   }
  272.  
  273.   $pathPart = preg_replace('@//+@', '/', $pathPart);
  274.  
  275.   return $serverPart . $pathPart;
  276. }
  277.  
  278. /**
  279. * Bounces the user to an alternative location, terminating execution of this script
  280. *
  281. * @param    string   $location    URL that the user should be redirected to
  282. * @returns  NEVER RETURNS
  283. */
  284. function redirectUser($location) {
  285.   header("Location: ". $location);
  286.   exit;
  287. }
  288.  
  289. ?>

Documentation generated on Tue, 06 Mar 2007 10:01:46 +0000 by phpDocumentor 1.3.0