Menu.php

<?php
/***********************************************************
 * Copyright (C) 2008-2011 Hewlett-Packard Development Company, L.P.
 * Copyright (C) 2014-2015 Siemens AG
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ***********************************************************/

namespace Fossology\Lib\UI\Component;

use Fossology\Lib\Auth\Auth;
use Twig_Environment;

class Menu
{
  const FULL_MENU_DEBUG = 'fullmenudebug';
  var $MenuTarget = "treenav";
  protected $renderer;

  public function __construct(Twig_Environment $renderer)
  {
    // Add default menus (with no actions linked to plugins)
    menu_insert("Main::Upload", 70);
    menu_insert("Main::Jobs", 60);
    menu_insert("Main::Organize", 50);
    menu_insert("Main::Help", -1);
    menu_insert("Main::Help::Documentation", 0, NULL, NULL, NULL, "<a href='http://www.fossology.org/projects/fossology/wiki/User_Documentation'>Documentation</a>");
    $this->renderer = $renderer;
  }

  function menu_html(&$menu, $indent)
  {
    if (empty($menu)) {
      return;
    }
    $output = "";
    $output .= "<!--[if lt IE 7]><table><tr><td><![endif]-->\n";
    $output .= "<ul id='menu-$indent'>\n";

    foreach ($menu as $menuEntry) {
      $output .= '<li>';

      if (!empty($menuEntry->HTML)) {
        $output .= $menuEntry->HTML;
      } else { /* create HTML */
        $output .= $this->createHtmlFromMenuEntry($menuEntry, $indent);
      }

      if (!empty($menuEntry->SubMenu)) {
        $output .= $this->menu_html($menuEntry->SubMenu, $indent + 1);
      }
    }
    $output .= "</ul>\n";
    $output .= "<!--[if lt IE 7]></td></tr></table></a><![endif]-->\n";
    return preg_replace("|<li><a href=\"#\"><font color(.*)*?$|m", '', $output);
  }

  function createHtmlFromMenuEntry(\menu $menuEntry, $indent)
  {
    $isFullMenuDebug = array_key_exists(self::FULL_MENU_DEBUG, $_SESSION) && $_SESSION[self::FULL_MENU_DEBUG] == 1;
    $output = "";
    if (!empty($menuEntry->URI)) {
      $output .= '<a  id="'. htmlentities($menuEntry->FullName) .'" href="' . Traceback_uri() . "?mod=" . $menuEntry->URI;
      if (empty($menuEntry->Target) || ($menuEntry->Target == "")) {
        $output .= '">';
      } else {
        $output .= '" target="' . $menuEntry->Target . '">';
      }
      if ($isFullMenuDebug) {
        $output .= $menuEntry->FullName . "(" . $menuEntry->Order . ")";
      } else {
        $output .= $menuEntry->Name;
      }
    } else {
      $output .= '<a id="'. htmlentities($menuEntry->FullName) .'" href="#">';
      if (empty($menuEntry->SubMenu)) {
        $output .= "<font color='#C0C0C0'>";
        if ($isFullMenuDebug) {
          $output .= $menuEntry->FullName . "(" . $menuEntry->Order . ")";
        } else {
          $output .= '';
        }
        $output .= "</font>";
      } else {
        if ($isFullMenuDebug) {
          $output .= $menuEntry->FullName . "(" . $menuEntry->Order . ")";
        } else {
          $output .= $menuEntry->Name;
        }
      }
    }

    if (!empty($menuEntry->SubMenu) && ($indent > 0)) {
      $output .= " <span>&raquo;</span>";
    }
    $output .= "</a>\n";
    return $output;
  }

  function OutputCSS()
  {
    $output = "";

    $output .= "<style type=\"text/css\">\n";
    /* Depth 0 is special: position is relative, colors are blue */
    $depth = 0;
    $label = "";
    $Menu = menu_find("Main", $MenuDepth);
    $cssBorder = "border-color:#CCC #CCC #CCC #CCC; border-width:1px 1px 1px 1px;";
    $cssPadding = "padding:4px 0px 4px 4px;";
    $FOSScolor1 = "#c50830";
    $FOSScolor2 = "#808080";
    $FOSSbg = "white";

    $FOSSfg1 = "black";
    $FOSSbg1 = "white";
    $FOSSfg1h = $FOSScolor1; // highlight colors
    $FOSSbg1h = "beige";

    $FOSSfg2 = "black";
    $FOSSbg2 = "beige";
    $FOSSfg2h = $FOSScolor1; // highlight colors
    $FOSSbg2h = "beige";

    $FOSSfg3 = "black";
    $FOSSbg3 = "beige";
    $FOSSfg3h = $FOSScolor1; // highlight colors
    $FOSSbg3h = "beige";

    if ($depth < $MenuDepth) {
      $output .= "\n/* CSS for Depth $depth */\n";
      $label = "ul#menu-" . $depth;
      $output .= $label . "\n";
      $output .= "  { z-index:0; margin:0; padding:0px; list-style:none; background:$FOSSbg1; width:100%; height:24px; font:normal 14px verdana, arial, helvetica; font-weight: bold; }\n";
      $label .= " li";
      $output .= $label . "\n";
      $output .= "  { float:left; margin:0; padding:0px; display:block; position:relative; width:auto; border:0px solid #000; }\n";
      $output .= $label . " a:link,\n";
      $output .= $label . " a:visited\n";
      $output .= "  { float:left; padding:4px 10px; text-decoration:none; color:$FOSSfg1; background:$FOSSbg1; width:auto; display:block; }\n";
      $output .= $label . ":hover a,\n";
      $output .= $label . " a:hover,\n";
      $output .= $label . " a:active\n";
      $output .= "  { float:left; padding:4px 10px; color:$FOSSfg1h; background:$FOSSbg1h; $cssBorder width:auto; display:block; }\n";
      $output .= $label . " a span\n";
      $output .= "  { float:left; position:absolute; top:0; left:135px; font-size:12pt; }\n";
      $depth++;
    }

    /* Depth 1 is special: position is absolute. Left is 0, top is 24 */
    if ($depth < $MenuDepth) {
      $output .= "\n/* CSS for Depth $depth */\n";
      $output .= $label . " ul#menu-" . $depth . "\n";
      $output .= "  { margin:0; padding:0px 0; list-style:none; display:none; visibility:hidden; left:0px; width:150px; position:absolute; top:24px; font-weight: bold; }\n";
      $output .= $label . ":hover ul#menu-" . $depth . "\n";
      $output .= "  { float:left; display:block; visibility:visible; }\n";
      $label .= " ul#menu-" . $depth . " li";
      $output .= $label . "\n";
      $output .= "  { z-index:$depth; margin:0; padding:0; display:block; visibility:visible; position:relative; width:150px; }\n";
      $output .= $label . " a:link,\n";
      $output .= $label . " a:visited\n";
      $output .= "  { z-index:$depth; $cssPadding color:$FOSSfg2; background:$FOSSbg2; border:1px solid #000; $cssBorder width:150px; display:block; visibility:visible; }\n";
      $output .= $label . ":hover a,\n";
      $output .= $label . " a:active,\n";
      $output .= $label . " a:hover\n";
      $output .= "  { z-index:$depth; $cssPadding color:$FOSSfg2h; background:$FOSSbg2h; width:150px; display:block; visibility:visible; }\n";
      $output .= $label . " a span\n";
      $output .= "  { text-align:left; }\n";
      $depth++;
    }

    /* Depth 2+ is recursive: position is absolute. Left is 150*(Depth-1), top is 0 */
    for (; $depth < $MenuDepth; $depth++) {
      $output .= "\n/* CSS for Depth $depth */\n";
      $output .= $label . " ul#menu-" . $depth . "\n";
      $output .= "  { margin:0; padding:1px 0; list-style:none; display:none; visibility:hidden; left:156px; width:150px; position:absolute; top:-1px; font-weight: bold; }\n";
      $output .= $label . ":hover ul#menu-" . $depth . "\n";
      $output .= "  { float:left; display:block; visibility:visible; }\n";
      $label .= " ul#menu-" . $depth . " li";
      $output .= $label . "\n";
      $output .= "  { z-index:$depth; margin:0; padding:0; display:block; visibility:visible; position:relative; width:150px; }\n";
      $output .= $label . " a:link,\n";
      $output .= $label . " a:visited\n";
      $output .= "  { z-index:$depth; $cssPadding color:$FOSSfg3; background:$FOSSbg2h; border:1px solid #000; $cssBorder width:150px; display:block; }\n";
      $output .= $label . ":hover a,\n";
      $output .= $label . " a:active,\n";
      $output .= $label . " a:hover\n";
      $output .= "  { z-index:$depth; $cssPadding color:$FOSSfg3h; background:$FOSSbg3h; width:150px; display:block; visibility:visible; }\n";
      $output .= $label . " a span\n";
      $output .= "  { text-align:left; }\n";
    }
    $output .= "</style>\n";

    /* For IE's screwed up CSS: this defines "hover". */
    $output .= "<!--[if lt IE 8]>\n";
    $output .= "<style type='text/css' media='screen'>\n";
    $output .= "body { behavior:url(csshover.htc); }\n";
    for ($i = 1; $i < $MenuDepth; $i++) {
      $output .= "#menu-$i table {height:0px; border-collapse:collapse; margin:0; padding:0; }\n";
      $output .= "#menu-$i td {height:0px; border:none; margin:0; padding:0; }\n";
    }
    $output .= "</style>\n";
    $output .= "<![endif]-->\n";

    $this->_CSSdone = 1;
    return ($output);
  } // OutputCSS()

  function Output($title = NULL)
  {
    global $SysConf;
    $sysConfig = $SysConf['SYSCONFIG'];

    $vars = array();
    $vars['title'] = empty($title) ? _("Welcome to FOSSology") : $title;
    $vars['bannerMsg'] = @$sysConfig['BannerMsg'];
    $vars['logoLink'] =  $sysConfig['LogoLink']?: 'http://fossology.org';
    $vars['logoImg'] =  $sysConfig['LogoImage']?: 'images/fossology-logo.gif';

    if ( array_key_exists('SupportEmailLabel',$sysConfig) && !empty($sysConfig['SupportEmailLabel'])
            && array_key_exists('SupportEmailAddr',$sysConfig) && !empty($sysConfig['SupportEmailAddr'])) {
      $menuItem = '<a href="mailto:'.$sysConfig['SupportEmailAddr'].'?subject='.@$sysConfig['SupportEmailSubject'].'">'.$sysConfig['SupportEmailLabel'].'</a>';
      menu_insert("Main::Help::".$sysConfig['SupportEmailLabel'], 0, NULL, NULL, NULL, $menuItem);
    }

    $menu = menu_find("Main", $MenuDepth);
    $vars['mainMenu'] = $this->menu_html($menu, 0);
    $vars['uri'] = Traceback_uri();

    /* Handle login information */
    $vars['isLoggedOut'] = ((empty($_SESSION[Auth::USER_NAME])) or ($_SESSION[Auth::USER_NAME] == "Default User"));
    $vars['isLoginPage'] = GetParm("mod", PARM_STRING)=='auth';

    global $SysConf;
    if (array_key_exists('BUILD', $SysConf)) {
      $vars['versionInfo'] = array(
          'version' => $SysConf['BUILD']['VERSION'],
          'buildDate' => $SysConf['BUILD']['BUILD_DATE'],
          'commitHash' => $SysConf['BUILD']['COMMIT_HASH'],
          'commitDate' => $SysConf['BUILD']['COMMIT_DATE'],
          'branchName' => $SysConf['BUILD']['BRANCH']
      );
    }

    if (!$vars['isLoggedOut']) {
      $this->mergeUserLoginVars($vars);
    }

    $out = $this->renderer->loadTemplate('components/menu.html.twig')->render($vars);
    return $out;
  }

  private function mergeUserLoginVars(&$vars)
  {
    global $container;
    $dbManager = $container->get("db.manager");

    $vars['logOutUrl'] = Traceback_uri() . '?mod=' . ((plugin_find_id('auth')>=0) ? 'auth' : 'smauth');
    $vars['userName'] = $_SESSION[Auth::USER_NAME];

    $sql = 'SELECT group_pk, group_name FROM group_user_member LEFT JOIN groups ON group_fk=group_pk WHERE user_fk=$1';
    $stmt = __METHOD__ . '.availableGroups';
    $dbManager->prepare($stmt, $sql);
    $res = $dbManager->execute($stmt, array($_SESSION['UserId']));
    $allAssignedGroups = array();
    while ($row = $dbManager->fetchArray($res)) {
      $allAssignedGroups[$row['group_pk']] = $row['group_name'];
    }
    $dbManager->freeResult($res);
    if (count($allAssignedGroups) > 1) {
      $vars['backtraceUri'] = Traceback_uri() . "?mod=" . Traceback_parm();
      $vars['groupId'] = $_SESSION[Auth::GROUP_ID];
      $vars['allAssignedGroups'] = $allAssignedGroups;
    } else {
      $vars['singleGroup'] = @$_SESSION['GroupName'];
    }
  }
}