Source for file funcs.inc.php

Documentation is available at funcs.inc.php

  1. <?php
  2. /**
  3.  * /opt/nac/bin/funcs.inc.php
  4.  *
  5.  * common PHP functions used by several scripts
  6.  *
  7.  * PHP version 5
  8.  *
  9.  * LICENSE: This program is free software; you can redistribute it and/or
  10.  * modify it under the terms of the GNU General Public License as published
  11.  * by the Free Software Foundation.
  12.  *
  13.  * @package            FreeNAC
  14.  * @author            Sean Boran (FreeNAC Core Team)
  15.  * @copyright        2007 FreeNAC
  16.  * @license            http://www.gnu.org/copyleft/gpl.html   GNU Public License Version 2
  17.  * @version            SVN: $Id$
  18.  * @link                http://www.freenac.net
  19.  *
  20.  */
  21.  
  22.  
  23. /**
  24. * Common PHP functions used by several scripts
  25. */
  26.  
  27. chdir(dirname(__FILE__));
  28. set_include_path("./:../lib/:../");
  29.  
  30. /**
  31. * Load automagically a file containing the class specified by classname
  32. * @param object $classname    Class to load
  33. */
  34. function __autoload($classname)
  35. {
  36.    if (is_readable("../lib/$classname.php"))
  37.       require_once "../lib/$classname.php";
  38.    else if (is_readable("../enterprise/$classname.php"))
  39.       require_once "../enterprise/$classname.php";
  40. }
  41.  
  42. /**
  43. * Get configuration variables from config file
  44. */
  45. require_once 'etc/config.inc';
  46.  
  47. /**
  48. * @global object $conf        Contains configuration parameters from the config table
  49. * @global object $logger    Provides for logging facilities
  50. */
  51. $logger=Logger::getInstance();
  52. $conf=Settings::getInstance();
  53.  
  54. /**
  55. * Tell if an IPv4 address is valid (well-formed)
  56. * @param string $ip    IP address to test
  57. *  return boolean    True if IP address is valid, false otherwise
  58. */
  59. function valid_ip($ip)
  60. {
  61.    $tmp = explode(".", $ip);
  62.    if (count($tmp) != 4)
  63.    {
  64.       return false;
  65.    }
  66.    else
  67.    {
  68.       foreach($tmp AS $sub)
  69.       {
  70.          if (!preg_match("/^([0-9]{1,3})$/", $sub))
  71.          {
  72.             return false;
  73.          }
  74.          if (($sub < 1) || ($sub > 255))
  75.          {
  76.             return false;
  77.          }
  78.       }
  79.    }
  80.    return true;
  81. }
  82.  
  83. /**
  84. * Get WINS Name from IP Address
  85. * Original contribution from johnboy68
  86. * @param string $ip   Ip Address
  87. * @return string      WINS Name
  88. */
  89. function getwinsfromip($ip)
  90. {
  91.    #Try to avoid command injection
  92.    $ip = ereg_replace("[|&;`]", "", $ip);
  93.    if (! valid_ip($ip))
  94.    {
  95.       return false;
  96.    }
  97.    /*
  98.    Successful query
  99.    
  100.    added interface ip=192.168.201.216 bcast=192.168.201.255 nmask=255.255.255.0
  101.    Socket opened.
  102.    Looking up status of 192.168.202.222
  103.         HOST59          <00> -         M <ACTIVE>
  104.         WORK            <00> - <GROUP> M <ACTIVE>
  105.         HOST59          <20> -         M <ACTIVE>
  106.         WORK            <1e> - <GROUP> M <ACTIVE>
  107.         WORK            <1d> -         M <ACTIVE>
  108.         ..__MSBROWSE__. <01> - <GROUP> M <ACTIVE>
  109.  
  110.         MAC Address = CC-00-FF-EE-EE-EE
  111.    */
  112.  
  113.    /*
  114.    Failed query
  115.    
  116.    added interface ip=192.168.201.216 bcast=192.168.201.255 nmask=255.255.255.0
  117.    Socket opened.
  118.    Looking up status of 192.168.202.223
  119.    No reply from 192.168.202.223
  120.    */
  121.  
  122.    /*
  123.    Case where we are trying to lookup the hostname of the server running this script
  124.  
  125.    added interface ip=192.168.201.216 bcast=192.168.201.255 nmask=255.255.255.0
  126.    Socket opened.
  127.    Looking up status of 192.168.202.216
  128.    No reply from 192.168.202.216   
  129.    */
  130.  
  131.    #Call nmblookup for this ip address
  132.    $command = "nmblookup -A $ip";
  133.    $output = shell_exec($command);
  134.    $foutput = explode("$ip",$output); // all after the IP
  135.    $foutput = explode(" ",$foutput[1]);    // fields sep. by spaces
  136.    $foutput = trim($foutput[0]);           // get first filed, i.e. STNS59 above
  137.    # Check if we have a result;
  138.    if ($foutput=="No")
  139.    {
  140.       #No result, return IP address
  141.       return mysql_escape_string($ip);
  142.    }
  143.    else if (strpos($ip,"bcast="))
  144.    {
  145.       return mysql_escape_string($ip);
  146.    }
  147.    else
  148.    {
  149.       #Return the hostname we've just learnt
  150.       return mysql_escape_string($foutput);
  151.    }
  152. }
  153.  
  154. /**
  155. * Converts a vlan id to a vlan name
  156. * @param integer $vlanID     Vlan ID
  157. * @return mixed         Vlan name
  158. */
  159. function vlanId2Name($vlanID) {
  160.    // Todo: Proper Error Handling, and use better Database abstraction
  161.    $vlan_name = NULL;
  162.    if (is_integer($vlanID))
  163.    {
  164.       $vlan_name=v_sql_1_select("select default_name from vlan where id='$vlanID' limit 1");
  165.       if ($vlan_name !== false)
  166.       {
  167.          return $vlan_name;
  168.       }
  169.       else
  170.       {
  171.          return false;
  172.       }
  173.    }
  174.    else
  175.    {
  176.       return false;
  177.    }
  178. }
  179.  
  180. /**
  181. * Get the last number of an SNMP OID
  182. * The OID is separated by dots and we use them as a separator.
  183. * Example: OID=1.2.3.4.5.6.7.8
  184. *       Returns: 8
  185. * @param mixed $oid        OID of interest
  186. * @return mixed            Last part of the OID.
  187. */
  188. function get_last_index($oid)                                                  
  189. {
  190.    if ( ! $oid )
  191.       return false;
  192.    $temp=explode('.',$oid);
  193.    return $temp[count($temp)-1];
  194. }
  195.  
  196. /**
  197. * Returns the difference between 2 dates in secs
  198. * @param mixed $date1            Date to substract from
  199. * @param mixed $date2            Date
  200. * @return mixed                Difference in second between those 2 dates
  201. */
  202. function time_diff($date1,$date2)
  203. {
  204.    if ($date1 && $date2)
  205.    {
  206.       $temp=explode(' ',$date1);
  207.       //Return false if there are no spaces in $date1
  208.       if (count($temp) == 1)
  209.          return false;
  210.       $time_info_1=explode(':',$temp[1]);
  211.       //Return false because the date format is not what we expected
  212.       if ( strcmp($time_info_1[0],$temp[1]) ===0 )
  213.          return false;
  214.       $date_info_1=explode('-',$temp[0]);
  215.       //Return false because the date format is not what we expected
  216.       if ( strcmp($date_info_1[0], $temp[0]) === 0 )
  217.          return false;
  218.       $temp=explode(' ',$date2);
  219.       //Return false if there are no spaces in $date2
  220.       if (count($temp) == 1)
  221.          return false;
  222.       $time_info_2=explode(':',$temp[1]);
  223.       //Return false because the date format is not what we expected
  224.       if ( strcmp($time_info_2[0],$temp[1]) ===0 )
  225.          return false;
  226.       $date_info_2=explode('-',$temp[0]);
  227.       //Return false because the date format is not what we expected
  228.       if ( strcmp($date_info_2[0], $temp[0]) === 0 )
  229.          return false;
  230.       $time1=mktime((int)$time_info_1[0],(int)$time_info_1[1],(int)$time_info_1[2],(int)$date_info_1[1],(int)$date_info_1[2],(int)$date_info_1[0]);
  231.       $time2=mktime((int)$time_info_2[0],(int)$time_info_2[1],(int)$time_info_2[2],(int)$date_info_2[1],(int)$date_info_2[2],(int)$date_info_2[0]);
  232.       if ( ($time1 !== false) && ($time2 !== false) )
  233.       {
  234.          $time=$time2-$time1;
  235.          return $time;
  236.       }
  237.       else
  238.       {
  239.          //Invalid arguments
  240.          return false;
  241.       }
  242.    }
  243.    else
  244.    {
  245.       //No dates were specified
  246.       return false;
  247.    }
  248. }
  249.  
  250. /**
  251. * Wrapper around the debug method part of the logger object.
  252. * Logs to debug level 1
  253. * It will be soon depreciated. Present only for backwards compatibility.
  254. * @param mixed $msg Message to log
  255. */
  256. function debug($msg) {
  257.    global $logger;
  258.    $msg=rtrim($msg);
  259.    if (strlen($msg)>0) {
  260.       $logger->debug($msg);
  261.    }
  262. } 
  263.  
  264. /**
  265. * Wrapper around the debug method part of the logger object.
  266. * Logs to debug level 1
  267. * It will be soon depreciated. Present only for backwards compatibility.
  268. * @param mixed $msg    Message to log
  269. */
  270. function debug1($msg) {
  271.   global $logger;
  272.   $msg=rtrim($msg);
  273.   if (strlen($msg)>0) {
  274.      $logger->debug($msg);
  275.   }
  276. }
  277.  
  278. /**
  279. * Wrapper around the debug method part of the logger object.
  280. * Logs to debug level 2
  281. * It will be soon depreciated. Present only for backwards compatibility.
  282. * @param mixed $msg     Message to log
  283. */
  284. function debug2($msg) {
  285.   global $logger;
  286.   $msg=rtrim($msg);
  287.   if (strlen($msg)>0) {
  288.      $logger->debug($msg,2);
  289.   }
  290. }
  291.  
  292. /**
  293. * Wrapper around the logit method part of the logger object.
  294. * It will be soon depreciated. Present only for backwards compatibility.
  295. * @param mixed $msg     Message to log
  296. */
  297. function logit($msg) {
  298.   global $logger;
  299.   $msg=rtrim($msg);
  300.   $logger->logit($msg);
  301. }
  302.  
  303. /**
  304. * Write key events to naclog which is visible from the GUI
  305. * This should NOT be called from a secondary server, i.e.
  306. * avoid it in vmpsd_external
  307. * @param mixed $level    Level of severity of the message
  308. * @param mixed $msg    Message to log
  309. */
  310. function log2db($level, $msg)
  311. {
  312.   if ( $level && $msg )
  313.   {
  314.      global $connect,$logger;
  315.      $msg=rtrim($msg);
  316.      if (strlen($msg)>0 ) {
  317.        db_connect();                 // just in case its not connected
  318.        #$query="INSERT DELAYED INTO naclog "
  319.        if (isset($_SERVER['HOSTNAME']))
  320.           $host=$_SERVER['HOSTNAME'];
  321.        else
  322.           $host='';
  323.        $query="insert into naclog set what='".mysql_real_escape_string($msg)."', host='$host', priority='".$level."'";
  324.        #$query="INSERT INTO naclog "
  325.        #  . "SET what='" . mysql_real_escape_string($msg )  . "', "
  326.        #  . "host='"     . mysql_real_escape_string($_SERVER["HOSTNAME"]) . "', "
  327.        #  . "priority='$level' ";
  328.        #$logger->logit("$query\n");
  329.        $res = mysql_query($query, $connect);
  330.        if (!$res) 
  331.        { 
  332.           $logger->logit('Cannot write to vmplog table: ' . mysql_error(), LOG_ERR); 
  333.           return false;
  334.        }
  335.        return true;
  336.      }
  337.      else
  338.         return false;
  339.    }
  340.    else
  341.       return false;
  342.   // To view recent entries:
  343.   // select * from naclog ORDER BY datetime DESC LIMIT 5;
  344. }
  345.  
  346.  
  347. ## log2db3: write to naclog if debug level=3 
  348. function log2db3($msg)
  349. {
  350.   if ($msg)
  351.   {
  352.      global $connect, $logger;
  353.      $level='debug';
  354.      $msg=rtrim($msg);
  355.      if (($logger->getDebugLevel()==3) && (strlen($msg)>0) ) {
  356.         db_connect();                 // just in case its not connected
  357.         #$query="INSERT INTO naclog "
  358.         $query="INSERT DELAYED INTO naclog "
  359.           . "SET what='" . $msg   . "', "
  360.           . "priority='" . $level . "' ";
  361.         #$logger->logit("$query\n");
  362.         $res = mysql_query($query, $connect);
  363.         if (!$res) 
  364.         { 
  365.            $logger->logit('Cannot write to vmplog table: ' . mysql_error(), LOG_ERR); 
  366.            return false;
  367.         }
  368.         return true;
  369.       }
  370.       else
  371.          return false;
  372.    }
  373.    else
  374.       return false;
  375. }
  376.  
  377. /**
  378. * Creates a connection to the MySQL database with the parameters defined in config.inc
  379. */
  380. function db_connect()
  381. {
  382.    global $connect, $dbhost, $dbuser, $dbpass, $dbname, $logger;
  383.  
  384.    if ( ! $connect=@mysql_connect($dbhost, $dbuser, $dbpass))
  385.    {
  386.       $logger->logit("Could not connect to mysql: " . mysql_error(), LOG_ERR);
  387.       exit(1);
  388.    }
  389.    if ( ! @mysql_select_db($dbname, $connect))
  390.    {
  391.       $logger->logit("Could not select database: ".mysql_error(), LOG_ERR);
  392.       exit(1);
  393.    }
  394. }
  395.  
  396. /**
  397.  * Abstract calling of unix commands.
  398.  * Problem: popen does not pass back command success
  399.  * so syscall cannot say if the command works.
  400.  * @param mixed $command    Command to be executed
  401.  * @return mixed        Result from that command
  402.  */
  403. function syscall($command){
  404.    if ($command)
  405.    {
  406.       $result='';
  407.       #if ( $proc = popen("($command) ","r") ) {
  408.       if ( $proc = popen("($command) 2>&1","r") ) {
  409.           while (!feof($proc))
  410.             $result .= fgets($proc, 1000);
  411.           pclose($proc);
  412.           #debug2("syscall(): executed $command, RETURN=$result");
  413.           return $result;
  414.       #} else {       # will never be reaches, popen does not pass back command success
  415.       #  logit("syscall error ", $proc);
  416.       #  return undef;
  417.       }
  418.       else
  419.          return false;
  420.    }
  421.    else return false;
  422. }
  423.  
  424. function ping_mac($mac)
  425. # Return: true=Ping successful
  426. {
  427.   db_connect();
  428.   global $connect, $logger;
  429.   
  430.   $query="SELECT r_ip from systems "
  431.         . " WHERE mac='" . $mac . "'";
  432.         #$logger->logit("$query\n");
  433.         $res= mysql_query($query, $connect);
  434.         if (!$res) 
  435.         { 
  436.            $logger->logit('Invalid query: ' . mysql_error(),LOG_ERR); 
  437.            exit(1);
  438.         }
  439.  
  440.    $rowcount=mysql_num_rows($res);
  441.  
  442.    if ($rowcount==1) {
  443.      list($ip)=mysql_fetch_array($res, MYSQL_NUM);
  444.      if (strlen($ip)<8) {
  445.        debug2("Invalid IP - $ip for mac $mac");
  446.        return(false); 
  447.      }
  448.      #debug2("ping $ip - $mac");
  449.      logit("ping $ip - $mac");
  450.  
  451.      // ping for max 1 sec, make sure it does not sty running/hung
  452.      #$answer=syscall("ping -c 1 -w 1 $ip");
  453.      $answer=syscall("ping -c 3 -w 1 $ip");
  454.      syscall("killall ping");
  455.      if ( preg_match("/0 received,/m", $answer) ) {
  456.        #$logger->logit "Ping Error: $answer\n";
  457.        logit("Ping Error no answer: $answer");
  458.        return false;
  459.  
  460.      } else if ( preg_match("/\d+ received,/m", $answer) ) {
  461.        #$logger->logit "Ping OK\n";
  462.        logit("Ping OK: $answer");
  463.        #logit("Ping OK");
  464.        return true;
  465.  
  466.      } else {
  467.        #$logger->logit "Ping Error: $answer\n";
  468.        logit("Ping Error: $answer");
  469.        return false;
  470.      }
  471.    } else {   #
  472.      logit("No IP found for $mac");
  473.      return false;
  474.    }
  475. }
  476.  
  477. /**
  478. * Perform a case insensitive search for a given value in an array and return its key
  479. * @param mixed $str    Value to look for
  480. * @param array $array    Array to look in
  481. * @return mixed        Key for that value, or false otherwise
  482. */
  483. function array_isearch($str,$array)                    
  484. {
  485.    if ($str && $array)
  486.    {
  487.       if ( ! is_array($array))
  488.          return false;
  489.       foreach($array as $k => $v)
  490.       {
  491.          if (strcasecmp($v,$str)==0)
  492.          {
  493.             return $k;
  494.          }
  495.       }
  496.       return false;
  497.    }
  498.    else
  499.       return false;
  500. }
  501.  
  502. /**
  503. * Perform a case insensitive search for a given value in a bi-dimensional array and return its key
  504. * @param mixed $str     Value to look for
  505. * @param array $array   Array to look in
  506. * @return mixed         Key for that value, or false otherwise
  507. */
  508. function array_multi_isearch($str,$array)
  509. {
  510.    if ($str && $array)
  511.    {
  512.       if ( ! is_array($array))
  513.          return false;
  514.       foreach($array as $k)
  515.       {
  516.          if (array_isearch($str,$k))
  517.             return $k;
  518.       }
  519.       return false;
  520.    }
  521.    else
  522.       return false;
  523. }
  524.  
  525. /**
  526. * Search the array for a given key and return its value, but using tokenizers
  527. * @param mixed $str             String to look for
  528. * @param array $array           Array where we should look in
  529. * @param mixed $token           Token to use as a separator
  530. * @param integer $number        The number of parts we want to return
  531. * @return mixed                 Desired value or false otherwise
  532. */
  533. function array_find_key($str,$array,$token,$number)   
  534. {
  535.    if ($str && $array && $token && $number)
  536.    {
  537.       if ( ! is_array($array))
  538.          return false;
  539.       #What if we have a string without tokens? 
  540.       #Add the token to the beginning of the string
  541.       #so we cover that case without affecting the strings
  542.       #containing the token 
  543.       $str = "$token$str";
  544.       foreach($array as $k => $v)
  545.       {
  546.          if (strcasecmp(str_get_last($k,$token,$number),str_get_last($str,$token,$number))==0)
  547.          {
  548.             return $v;
  549.          }
  550.       }
  551.       return false;
  552.    }
  553.    else
  554.       return false;
  555. }
  556.  
  557. /**
  558. * Search the array for a given value and return it, but using tokenizers
  559. * @param mixed $str        String to look for
  560. * @param array $array        Array where we should look in
  561. * @param mixed $token        Token to use as a separator
  562. * @param integer $number    The number of parts we want to return
  563. * @return mixed            Desired value or false otherwise
  564. */
  565. function array_find_value($str,$array,$token,$number)   
  566. {
  567.    if ($str && $array && $token && $number)
  568.    {
  569.       if ( ! is_array($array))
  570.          return false;
  571.       foreach($array as $k => $v)
  572.       {
  573.          if (strcasecmp(str_get_last($v,$token,$number),str_get_last($str,$token,$number))==0)
  574.          {
  575.             return $v;
  576.          }
  577.       }
  578.       return false;
  579.    }
  580.    else
  581.       return false;
  582. }
  583.  
  584. /**
  585. * Return the last parts of a tokenized string
  586. * @param $string    String to split
  587. * @param $token        Token to use to split the string
  588. * @param $number    How many parts we want to return
  589. * @return mixed        Desired string
  590. */
  591. function str_get_last($string,$token,$number)          
  592. {
  593.    $final='';
  594.    if