Source for file WebCommon.php

Documentation is available at WebCommon.php

  1. <?php
  2. /**
  3.  *
  4.  * WebCommon.php
  5.  *
  6.  * Long description for file:
  7.  * Class of common objects/functions for the WebGUI
  8.  * see also the 'Common' Class which this extends
  9.  *
  10.  * @package     FreeNAC
  11.  * @author      FreeNAC Core Team
  12.  * @copyright   2008 FreeNAC
  13.  * @license     http://www.gnu.org/copyleft/gpl.html   GNU Public License Version 3
  14.  * @version     SVN: $Id
  15.  * @link        http://freenac.net
  16.  *
  17.  */
  18. class WebCommon extends Common 
  19. {
  20.   // see also Variables inherited from Common
  21.   protected $calling_script, $calling_href, $module, $table;   
  22.  
  23.   function __construct($show_header=true, $debuglevel=1)
  24.   {
  25.     parent::__construct();
  26.     $this->calling_script=basename($_SERVER['SCRIPT_FILENAME']);   // TBD: clean unneeded, trust apache?
  27.     if (isset($_SESSION['caller'])) {
  28.       $this->calling_href=$_SESSION['caller'];    // TBD: needed? same as calling_script?
  29.     }
  30.     $this->module='WebCommon';
  31.     $this->logger->setDebugLevel($debuglevel);  // 3 for max debugging
  32.     $this->remote_host=validate_webinput($_SERVER['REMOTE_ADDR']);
  33.  
  34.     if (! function_exists('mysqli_connect')) {
  35.       throw new DatabaseErrorException("PHP has not been compiled with mysqli support");
  36.     }
  37.  
  38.     if ($show_header===true) // Show Webpage start, is the constructor the right place?
  39.       echo $this->print_header();  
  40.   }
  41.  
  42.   /**
  43.    * Add the class name and uid to debug messages
  44.    */
  45.   public function debug($msg, $level=1) 
  46.   {
  47.     if (isset($_SESSION['uid'])) {
  48.        $this->logger->debug("uid={$_SESSION['uid']} "  .get_class($this) ." " .$msg, $level);
  49.     } else {
  50.        $this->logger->debug(get_class($this) ." " .$msg, $level);
  51.     }
  52.   }
  53.  
  54.   public function logit($msg) 
  55.   {
  56.     if (isset($_SESSION['uid'])) {
  57.        $this->logger->logit("uid={$_SESSION['uid']} "  .get_class($this) ." " .$msg);
  58.     } else {
  59.        $this->logger->logit(get_class($this) ." " .$msg);
  60.     }
  61.   }
  62.  
  63.  
  64.  
  65.   public function loggui($msg, $who=0, $priority='info')
  66.   {
  67.     $conn=$this->getConnection();     //  make sure we have a DB connection
  68.  
  69.     if ( (isset($_SESSION['uid'])) && ($who===0) ) {
  70.       $who=$_SESSION['uid'];
  71.     }
  72.     $q="insert into guilog (who, host, datetime, priority, what)
  73.          values ('$who', '$this->remote_host', NOW(), '$priority', 'Web: $msg')";
  74.       $this->debug($q, 3);
  75.       $res = $conn->query($q);
  76.       if ($res === FALSE)
  77.         throw new DatabaseInsertException("Unable to insert guilog entry:: " .$conn->error);
  78.   }
  79.  
  80.  
  81.   public function print_logo()
  82.   {
  83.     global $head_left1;
  84.     return $head_left1 . "\n";
  85.   }
  86.   public function print_headerSmall($print_links=true)
  87.   {
  88.     $this->print_header($print_links);
  89.   }
  90.  
  91.   public function print_header($print_links=true)
  92.   {
  93.     global $header1;
  94.     $ret='';
  95.  
  96.     if (defined('HEADER')){   // already displayed?
  97.       $this->debug('print_header: HEADER already true', 3);
  98.  
  99.     } else {
  100.       if (! isset($_SESSION['nac_rights']) || ($_SESSION['nac_rights']=='')) {
  101.         $this->debug("print_header() nac_rights not set: ignore, do not show menu/headers", 2);
  102.         return;
  103.       }
  104.  
  105.       define('HEADER',true); // The header is out
  106.       $ret.= $header1 ."\n";
  107.       #$ret.= $_SESSION['nac_rights'];
  108.       $ret.= $this->print_logo() ."\n";
  109.       $ret.= main_menu();     // webfuncs.inc
  110.       $this->debug('print_header: done', 3);
  111.     }
  112.     return $ret;
  113.   }
  114.  
  115.  
  116.   public function print_headerMin()
  117.   {
  118.     global $header1;
  119.  
  120.     if (defined('HEADER')){   // already displayed?
  121.       $this->debug('print_headerMin: HEADER already true',2);
  122.     #} 
  123.     #else {
  124.       return $header1;
  125.     }
  126.   }
  127.  
  128.   public function print_header1()
  129.   {
  130.     global $header1;
  131.     $ret= $header1 ."\n";
  132.     $ret.= $this->print_logo() ."\n";
  133.     return $ret;
  134.   }
  135.  
  136.  
  137.   public function print_footer($print_links=true)
  138.   {
  139.     global $sql_auth, $drupal_auth;
  140.     $text='';
  141.  
  142.     if (defined('FOOTER')){   // already displayed?
  143.       $this->debug('print_footer: FOOTER already true',2);
  144.     } 
  145.     else {
  146.       if (!isset ($_SESSION['login_data'])) {
  147.         $userdata=">> Not logged in <<";
  148.         $text=<<<EOF
  149.   </tr> </table> 
  150.   </body> </html>
  151. EOF;
  152.       }
  153.       else {
  154.         $userdata="<br>Logged in as: " .$_SESSION['login_data']
  155.           ." (" .$_SESSION['nac_rights_text'] .")";
  156.  
  157.         if (($sql_auth===true) || ($drupal_auth===true)) {
  158.           $logout_button="<li><a href='./logout.php'>Log out</a></li>";
  159.         }
  160.         else {
  161.           $logout_button='';
  162.         }
  163.  
  164.         $text=<<<EOF
  165.   <div id='user_footer'><p>$userdata</p></div>
  166.   <a href='./logout.php'>Log out</a>
  167. EOF;
  168.         if ($print_links===true) {
  169. // Stop for now, not needed with the new menus?
  170. #          $text.=<<<EOF
  171. #  <div id="headermenue">
  172. #  <ul>
  173. #     <li><A HREF='javascript:javascript:history.go(-1)'< Back</A></li>
  174. #     <li><a href="./index.php">Main Menu</a></li>
  175. #     $logout_button
  176. #  </ul> </div>
  177. #EOF;
  178.         }
  179.         $text.=<<<EOF
  180.   </tr> </table> </body> </html>
  181. EOF;
  182.  
  183.       }
  184.       return $text;
  185.  
  186.     }
  187.   }
  188.  
  189.  
  190.   /* no menu on the botton */
  191.   public function print_footer_empty()
  192.   {
  193.     if (defined('FOOTER')){   // already displayed?
  194.       $this->debug('print_footer: FOOTER already true',2);
  195.     } 
  196.     else {
  197.       $ret="</table></body></html>";
  198.       define('FOOTER',true);
  199.       return $ret;
  200.     }
  201.   }
  202.  
  203.  
  204.  
  205.   public function print_title($title)
  206.   {
  207.     $ret= $this->print_header();
  208.     $ret.= "<div id='GuiList1Title'>{$title}</div>";
  209.     $this->debug("print_title($title)" , 3);
  210.     return $ret;
  211.   }
  212.  
  213.  
  214.   /**
  215.    * Delete a record from the WebGUI
  216.    */
  217.   public function Delete($table, $id)
  218.   {
  219.     global $_SESSION, $_REQUEST;
  220.  
  221.     if ($_SESSION['nac_rights']<2)
  222.       throw new InsufficientRightsException($_SESSION['nac_rights']);
  223.     if ( $id===0 )
  224.       throw new InvalidWebInputException("Delete() invalid index: zero");
  225.     if ( strlen($table)===0 )
  226.       throw new InvalidWebInputException("Delete() no table name.");
  227.     
  228.     $ret = $this->print_title("Delete {$this->module} record");
  229.  
  230.     #var_dump($_REQUEST);
  231.     $conn=$this->getConnection();     //  make sure we have a DB connection
  232.     $this->debug("Delete() index {$id}", 3);
  233.  
  234.     $q="DELETE FROM {$table} WHERE id='{$id}' LIMIT 1";     // only this record
  235.       $this->debug($q, 3);
  236.       $res = $conn->query($q);
  237.       if ($res === FALSE)
  238.         throw new DatabaseErrorException($q ." :: " .$conn->error);
  239.  
  240.     // Inform the user that is was OK
  241.       $txt=<<<TXT
  242. <p class='UpdateMsgOK'>Delete of entry with index=$id Successful</p>
  243.  <br><p>Go back to the <a href="{$this->calling_href}">{$this->module} list</a></p>
  244. </div>
  245. TXT;
  246.     $ret.= $txt;
  247.     $this->logit("Deleted {$this->module}: table=$table, Id={$id}");
  248.     $this->loggui("Deleted {$this->module}: table=$table, Id={$id}");
  249.     return $ret;
  250.   }
  251.  
  252.  
  253. // ------------ functions common to the FreeNAC DB scheam, to be reused where possible in the
  254. // ------------ Web GUI
  256. /**
  257.  * Get a Vlan name, given its index number
  258.  */
  259. public function get_vlan($s)
  260. {
  261.    $conn=$this->getConnection();     //  make sure we have a DB connection
  262.    $ret='';
  263.    $q="select default_name from vlan where id='$s'";
  264.      $res = $conn->query($q);
  265.      if ($res === FALSE)
  266.        throw new DatabaseErrorException($q .'; ' .$conn->error);
  267.  
  268.      while (($row = $res->fetch_assoc()) !== NULL) {
  269.          $ret=$row['default_name'];
  270.      }
  271.    return($ret);
  272. }
  273.  
  274.  
  275. /**
  276.  * Look up what systems were seen on a port in the last $conf->web_lastdays days
  277.  */
  278. public function get_hosts($port) 
  279. {
  280.   $conn=$this->getConnection();     //  make sure we have a DB connection
  281.   $ret='';
  282. $q=<<<TXT
  283. SELECT s.name, 
  284.   s.LastSeen, CONCAT(users.Surname, ' ',users.GivenName, ', ',users.Department) as owner 
  285.   FROM systems as s 
  286.   LEFT JOIN users ON users.id = s.uid 
  287.   WHERE LastPort='$port'  AND (TO_DAYS(LastSeen)>=TO_DAYS(CURDATE())-{$this->conf->web_lastdays}) 
  288. TXT;
  289.      //$this->debug($q ,3);
  290.      $res = $conn->query($q);
  291.      if ($res === FALSE)
  292.        throw new DatabaseErrorException($q .'; ' .$conn->error);
  293.  
  294.      while (($row = $res->fetch_assoc()) !== NULL) {
  295.          $ret.=$row['name'] .' (' .$row['owner'] .'), ' .$row['LastSeen'] .'<br>';
  296.      }
  297.    //$this->debug($ret ,3);
  298.    return($ret);
  299. }
  300.  
  301.  
  302. /**
  303.  * Look up the first switch or patch location ID for a port
  304.  */
  305. public function get_locationid($port) 
  306. {
  307.   $conn=$this->getConnection();     //  make sure we have a DB connection
  308.   $query = "SELECT patchloc.id as patchlocid, switchloc.id as switchlocid FROM port
  309.                   LEFT JOIN patchcable ON patchcable.port = port.id
  310.                    LEFT JOIN location patchloc ON patchloc.id = patchcable.office
  311.                   LEFT JOIN switch ON switch.id = port.switch
  312.                    LEFT JOIN location switchloc ON switchloc.id = switch.location WHERE port.id = '$port';";
  313.   $res = $conn->query($q);
  314.   if ($res === FALSE)
  315.        throw new DatabaseErrorException($q .'; ' .$conn->error);
  316.  
  317.   while (($row = $res->fetch_assoc()) !== NULL) {
  318.  
  319.        if (($row['patchlocid'] = '') || (!$row['patchlocid'])) {
  320.          return($row['switchlocid']);
  321.        } 
  322.        else {
  323.          return($row['patchlocid']);
  324.        }
  325.   }
  326. }
  327.  
  328.  
  329. /**
  330.  * Lookup the patch outlet name
  331.  */
  332. public function get_patch($port)
  333. {
  334.   $conn=$this->getConnection(); 
  335.   $q = "SELECT outlet,location.name as location FROM patchcable LEFT JOIN location ON location.id = patchcable.office WHERE port='$port'";
  336.   $res = $conn->query($q);
  337.   if ($res === FALSE)
  338.        throw new DatabaseErrorException($q .'; ' .$conn->error);
  339.  
  340.   while (($row = $res->fetch_assoc()) !== NULL) {
  341.     return($row['outlet'] ." (" .$row['location'] .")");
  342.   } 
  343.   return(FALSE);
  344. }
  345.  
  346.  
  347. /**
  348.  * Lookup the patch outlet name
  349.  */
  350. public function get_dose($port)
  351. {
  352.   $conn=$this->getConnection(); 
  353.   $q = "SELECT outlet FROM patchcable WHERE port='$port'";
  354.   $res = $conn->query($q);
  355.   if ($res === FALSE)
  356.        throw new DatabaseErrorException($q .'; ' .$conn->error);
  357.  
  358.   while (($row = $res->fetch_assoc()) !== NULL) {
  359.     return($row['outlet']);
  360.   } 
  361.   return(FALSE);
  362. }
  363.  
  364.  
  365. /**
  366.  * Print a HTML lookup list of switches
  367.  */
  368. public function print_switch_sel($sw)
  369. {
  370.   $conn=$this->getConnection(); 
  371.   $q = "SELECT DISTINCT(switch.id) as id, switch.name as name, switch.ip as ip, CONCAT(building.name,' ',location.name) as location
  372.  FROM systems
  373.  LEFT JOIN port ON port.id = systems.LastPort
  374.  LEFT JOIN switch ON port.switch = switch.id
  375.  LEFT JOIN location ON location.id = switch.location
  376.   LEFT JOIN building ON building.id = location.building_id
  377. WHERE  (TO_DAYS(LastSeen)>=TO_DAYS(CURDATE())-" .$this->conf->web_lastdays .") AND port.switch != ''
  378. ORDER BY switch.name;";
  379.  
  380.   $this->debug($q, 3);
  381.   $res = $conn->query($q);
  382.   $html="<select name=sw>\n";
  383.   if ($res === FALSE)
  384.        throw new DatabaseErrorException($q .'; ' .$conn->error);
  385.  
  386.   while (($row = $res->fetch_assoc()) !== NULL) {
  387.     $html .= '<option value="' .$row['id'] .'"';
  388.     if ($sw == $row['id']) {
  389.       $html .= ' selected ';
  390.     };
  391.     $html .='>'.$row['name'].' ('.$row['location'].")</option>\n";
  392.   };
  393.   $html .= "</select>\n";
  394.   return($html);
  395. }
  396.  
  397. /* not used? */
  398. function print_dot_sel() 
  399. {
  400.   $types = array('dot','neato','fdp','twopi','circo');
  401.   $html = "<select name=\"dottype\">\n";
  402.  
  403.   foreach ($types as $mytype) {
  404.     $html .= '<option value="'.$mytype.'"';
  405.     if ($this->conf->web_dotcmd == $mytype) {
  406.       $html .= ' selected ';
  407.     };
  408.     $html .= ">$mytype</option>\n";
  409.   };
  410.   $html .= "</select>\n";
  411.   return($html);
  412. }
  413.  
  414.  
  415.  
  416.  
  417. /**
  418.  * Get port comment
  419.  */
  420. public function get_port_comment($port) 
  421. {
  422.   $conn=$this->getConnection();     //  make sure we have a DB connection
  423.   // TBD: could really look up the port/switch name for nicer logging?
  424.   if (isset($port) && is_numeric($port) && $port>1 ) {
  425.  
  426.     $this->debug("get_port_comment $port", 1);
  427.     $q="SELECT comment from port WHERE id=$port LIMIT 1";
  428.       $this->debug($q, 3);
  429.       $res = $conn->query($q);
  430.     if ($res === FALSE)
  431.       throw new DatabaseErrorException($conn->error);
  432.     while (($row = $res->fetch_assoc()) !== NULL) {
  433.       return ($row['comment']);
  434.     }
  435.  
  436.   } else {
  437.     $this->logit("get_port_comment invalid port index=<$port>");
  438.     // return nothing
  439.   }
  440. }
  441.  
  442.  
  443. /**
  444.  * Set the restart flag for a port
  445.  */
  446. public function port_restart_request($port) 
  447. {
  448.   $conn=$this->getConnection();     //  make sure we have a DB connection
  449.  
  450.   // TBD: could really look up the port/switch name for nicer logging?
  451.  
  452.   if (isset($port) && is_numeric($port) && $port>1 ) {
  453.  
  454.     $this->debug("port_restart_request $port", 1);
  455.     $this->loggui("Port index $port restart requested");
  456.     $q="UPDATE port set restart_now=1 WHERE id=$port LIMIT 1";
  457.       $this->debug($q, 3);
  458.       $res = $conn->query($q);
  459.     if ($res === FALSE)
  460.       throw new DatabaseErrorException($conn->error);
  461.     return true;
  462.  
  463.   } else {
  464.     $this->logit("port_restart_request invalid port index=<$port>");
  465.     return false;
  466.   }
  467. }
  468.  
  469. /**
  470.  * Delete a port
  471.  */
  472. public function port_delete($port)
  473. {
  474.   $conn=$this->getConnection();     //  make sure we have a DB connection
  475.  
  476.   // TBD: could really look up the port/switch name for nicer logging?
  477.   if (isset($port) && is_numeric($port) && $port>1 ) {
  478.  
  479.     $this->debug("port_delete $port", 1);
  480.     $q="DELETE from port WHERE id=$port LIMIT 1";
  481.       $this->debug($q, 3);
  482.       $res = $conn->query($q);
  483.     if ($res === FALSE)
  484.       throw new DatabaseErrorException($conn->error);
  485.  
  486.     $this->loggui("Port $port deleted ");
  487.     $this->logit("Port $port deleted ");
  488.   } else {
  489.     $this->logit("port_delete invalid port=$port");
  490.   }
  491. }
  492.  
  493.  
  494. /**
  495.  * Look up the first switch or patch location for a port
  496.  */
  497. public function get_location($port) 
  498. {
  499.   $conn=$this->getConnection();     //  make sure we have a DB connection
  500. $q=<<<TXT
  501. SELECT patchloc.id as patchlocid, CONCAT(patchbd.name,' ',patchloc.name) as patchloc,
  502.    switchloc.id as switchlocid, CONCAT(switchbd.name,' ',switchloc.name) as switchloc
  503.    FROM port
  504.    LEFT JOIN patchcable ON patchcable.port = port.id
  505.    LEFT JOIN location patchloc ON patchloc.id = patchcable.office
  506.    LEFT JOIN building as patchbd ON patchbd.id = patchloc.building_id
  507.    LEFT JOIN switch ON switch.id = port.switch
  508.    LEFT JOIN location switchloc ON switchloc.id = switch.location
  509.    LEFT JOIN building as switchbd ON switchbd.id = switchloc.building_id
  510.    WHERE port.id = '$port'
  511. TXT;
  512.  
  513.   $res = $conn->query($q);
  514.   if ($res === FALSE)
  515.        throw new DatabaseErrorException($q .'; ' .$conn->error);
  516.  
  517.   while (($row = $res->fetch_assoc()) !== NULL) {
  518.  
  519.        if (($row['patchloc'] = '') || (!$row['patchloc'])) {
  520.          return($row['switchloc']);
  521.        } 
  522.        else {
  523.          return($row['patchloc']);
  524.        }
  525.   }
  526. }
  527.  
  528. public function strip_datversion($long_version) 
  529. {
  530.      $list=explode('.',$long_version);
  531.      $short_version = $list[2];
  532.      return($short_version);
  533. }
  534.  
  535.  
  536. public function print_dat_stats($q) 
  537. {
  538.   $conn=$this->getConnection();     //  make sure we have a DB connection
  539.   $readme_url='http://vil.nai.com/vil/DATReadme.aspx';
  540.   $ret='';
  541.   $unknown='';
  542.   $total=0;
  543.   $res = $conn->query($q);
  544.   if ($res === FALSE)
  545.        throw new DatabaseErrorException($q .'; ' .$conn->error);
  546.  
  547.   $ret.= "<table cellspacing=0 cellpadding=5 border=1>\n";
  548.   $ret.= "<tr><th><a href=\"$readme_url\">DAT Version</a><th>count";
  549.  
  550.      while (($row&