functions.php

<?php
/*
 @nom: functions
 @auteur: piwebpool (info@infrafast.com)
 @description: all utilities reused across the application
*/
//


require "include/FreeSMS.php";
include("include/php_serial.class.php");
include_once('include/phpMyGraph5.0.php'); 
#include("configuration.php");
/*
wiringPi
Pin 	BCM
GPIO 	Name 	Header 	Name 	BCM
GPIO 	wiringPi
Pin
– 	– 	3.3v 	1 | 2 	5v 	– 	–
8 	0 	SDA0 	3 | 4 	DNC 	– 	–
9 	1 	SCL0 	5 | 6 	0v 	– 	–
7 	4 	GPIO 7 	7 | 8 	TxD 	14 	15
– 	– 	DNC 	9 | 10 	RxD 	15 	16
0 	17 	GPIO 0 	11 | 12 	GPIO 1 	18 	1
2 	21 	GPIO 2 	13 | 14 	DNC 	– 	–
3 	22 	GPIO 3 	15 | 16 	GPIO 4 	23 	4
– 	– 	DNC 	17 | 18 	GPIO 5 	24 	5
12 	10 	MOSI 	19 | 20 	DNC 	– 	–
13 	9 	MISO 	21 | 22 	GPIO 6 	25 	6
14 	11 	SCLK 	23 | 24 	CE0 	8 	10
– 	– 	DNC 	25 | 26 	CE1 	7 	11
*/


function registerMaterialURLCallBack($material,$url,$valueOn,$valueOff){
    global $options; 
    mysql_connect($options["database"]["host"],$options["database"]["username"],$options["database"]["password"]) or die('error connection');
    mysql_select_db($options["database"]["name"]) or die('error database selection');
    // in case of duplicate, simply erase
    $query="INSERT INTO `listeners` (`url`, `material`, `valueOn`, `valueOff`) VALUES ('".$url."', '".$material."', '".$valueOn."', '".$valueOff."') ON DUPLICATE KEY UPDATE url='".$url."',material='".$material."',valueOn='".$valueOn."',valueOff='".$valueOff."'";
    $outcome = mysql_query($query);
    //appendlog("registerMaterialURLCallBack",$query,$outcome);
    if (!$outcome) return false; else return true;
}

function weburl($url,$statusKey){
    if(!function_exists("curl_init")) die("cURL extension is not installed");
    $curl_options = array(
                        CURLOPT_URL => $url,
                        CURLOPT_HEADER => 0,
                        CURLOPT_RETURNTRANSFER => TRUE,
                        CURLOPT_TIMEOUT => 0,
                        CURLOPT_SSL_VERIFYPEER => 0,
                        CURLOPT_FOLLOWLOCATION => TRUE,
                        CURLOPT_ENCODING => 'gzip,deflate'                                    
                );
    $ch = curl_init();
    curl_setopt_array( $ch, $curl_options );
    $output = curl_exec( $ch );
    curl_close($ch);
    $arr = json_decode($output,true);
    appendlog("WEBURL",$url,$statusKey."=".$arr[$statusKey]);
    return $arr[$statusKey];
}

function sendsms($message,$destination){
    $SMSuser = "youruserid";
    $SMSkey = "yourpasskey";
    $feedback="void";            
    $result=true;
    if (!sms( $SMSuser, $SMSkey, $message,$feedback )) $result=false;
    appendlog("SENDSMS:",$result==true?"OK":"ERROR",$feedback);
    return $result;
}

function sendemail($message,$to="szemrot@hotmail.com"){
    // send email
    // subject and recipee should be extracted from settings.
    //html decode to display accents
    $message=html_entity_decode(wordwrap($message,70));
    $subject = "Notification de ".gethostname();
    $from = "noreply@piwebpool.infrafast.github.io";
    $headers = "From:" . $from;
    $result = mail($to,$subject,$message,$headers);
    appendlog("SENDMAIL:",$result==true?"OK":"ERROR",$message);
    return $result;
}

function appendlualog($message,$source="LUALOG"){
    return appendlog($source,"NOTIFICATION",$message);
}

function appendlog($source,$answer,$status,$filename="logfile.txt"){
// Appends lines to file and makes sure the file doesn't grow too much
    $result=true;
    // remove \n and \r so logfile are written on one line only except the last one
    $text =  preg_replace('~[\r\n]+~', '', "[".date("Y-m-d H:i:s")."][".$source.' ' .$answer."][".html_entity_decode($status)."]")."\n";
	if (!file_exists($filename)) { touch($filename); chmod($filename, 0666); }
	// file = 50kB
	if (filesize($filename) > 100000) {
		$filename2 = $filename.".old";
		if (file_exists($filename2)) unlink($filename2);
		rename($filename, $filename2);
		touch($filename); chmod($filename,0666);
	}
	if (!is_writable($filename)) die("<p>\nCannot open log file ($filename)");
	if (!$handle = fopen($filename, 'a')) die("<p>\nCannot open file ($filename)");
	if (fwrite($handle, $text) === false) die("<p>\nCannot write to file ($filename)");
	fclose($handle);
	return $result;
    //return file_put_contents($logfilename, "[".date("Y-m-d H:i:s")."][".$source.' ' .$answer."][".html_entity_decode($status)."]\n" , FILE_APPEND | LOCK_EX);
}

function getLog($logfilename, $lines = 100){
    $data = '';
    $filename="./".$logfilename;
    $fp = fopen($filename, "r");
    $block = 4096;
    $max = filesize($filename);
    
    for($len = 0; $len < $max; $len += $block) 
    {
        $seekSize = ($max - $len > $block) ? $block : $max - $len;
        fseek($fp, ($len + $seekSize) * -1, SEEK_END);
        $data = fread($fp, $seekSize) . $data;
    
        if(substr_count($data, "\n") >= $lines + 1) 
        {
            /* Make sure that the last line ends with a '\n' */
            if(substr($data, strlen($data)-1, 1) !== "\n") {
                $data .= "\n";
            }
    
            preg_match("!(.*?\n){". $lines ."}$!", $data, $match);
            fclose($fp);
            return $match[0];
        }
    }
    fclose($fp);
    return $data; 
}


function sms($SMSkey, $SMSuser,$message,&$feedback){
     $sms = new FreeMobile();
    $sms->setKey($SMSkey)
        ->setUser($SMSuser);
    try {
        // envoi d'un message
        $sms->send($message);
        $feedback = "sent";
        return true;
    } catch (Exception $e) {
        $feedback = $e->getCode()." ".$e->getMessage();
        //echo "Erreur sur envoi de SMS: ".$feedback;
        return false;
    }    
}


function getPinState($pin,$pins){
	$commands = array();
	return getPin($pins[$pin]);
}

function getLuaPin($pin){
	return getPin($pin)==0?"Off":"On";
}

function getPin($pin){
    // this function is to abstract one parameter when called from lua
    // it return 0 or 1 to beconsistent with set and to ease the testing 
    // contrary to the sub-function which is called from php
    exec("gpio read ".$pin,$commands,$return);
    //echo "exec gpio read ".$pin;
    // relay : normally close
    return (trim($commands[0])=="1"?0:1);
}

function setLuaPinState($pin,$state){
    //appendlualog("call setPinState(".$pin.",".$state.")");
    return setPinState($pin,$state=="Off"?0:1);
}

function setPinState($pin,$state){
    global $materials, $options, $pins;
    sleep(1);
    if ($state!=getPin($pin)){
    
        // retrieve the list of all listeners for this material
        mysql_connect($options["database"]["host"],$options["database"]["username"],$options["database"]["password"]) or die('error connection');
        mysql_select_db($options["database"]["name"]) or die('error database selection');
        //revert the material name from its pin value
        $material = array_search(array_search($pin,$pins), $materials);
        // retrieve all registered url for this material
        $sql    = "SELECT url,material,valueOn,valueOff from listeners where material='".$material."';";
        //appendlog("FIRE",$sql,"");
        $outcome = mysql_query($sql);
        if (!$outcome) {
            appendlog("ERROR",$sql,mysql_error());
        }else{
            while ($row = mysql_fetch_assoc($outcome)) {
                $url=($row['url']);
                if ($state==1){
                    $cmd=$row['valueOn'];
                }else{
                    $cmd=$row['valueOff'];
                }
                // replace the %v in the URL string by the value
                $url = str_ireplace("%v",$cmd,$url);
                // replace the %m in the URL string by the value
                $url = str_ireplace("%m",$material,$url);
                //appendlog("FIRE",$state,$url);
                appendlog("SWITCH",$material,$state==0?"Off":"On");
                //issue #24
                //here we put "status" which is the keyword we ecpect to get from the json reply 
                //we however don't exploit the result of the call function because this should be 
                // 1) pass as a parameter to the weburl extracted from the listeners table
                // 2) then it cause the question about the return to the function itself where a NOK from weburl
                // should not return false if th setPin command was successful...
                //fire the state change to all listeners
                weburl($url,"status");
            }
        }    
        //Definis le PIN en tant que sortie
    	system("gpio mode ".$pin." out");
    	//Active/désactive le pin
    	$state=($state==0?1:0);
    	
    	system("gpio write ".$pin." ".$state);
    	//echo "{gpio write ".$pin." ".$state."}";
    	// here we should capture with the feedback pin and set return accordingly to manage the state"unknown"
    }
	return true;
}

function getDevice($id){
    try{
        if ($data = file('USBdevices.id')){
            $returnArray = array();
            foreach($data as $line) {
                $explode = explode(":", $line);
                $returnArray[$explode[0]] = $explode[1];
            }
            return preg_replace( "/\r|\n/", "", $returnArray[$id]);
        }
    }catch (Exception $e){
    }
    return null;
}

function getSetting($id){
    global $options;

    mysql_connect($options["database"]["host"],$options["database"]["username"],$options["database"]["password"]) or die('error connection');
    mysql_select_db($options["database"]["name"]) or die('error database selection');
    $sql = "SELECT value from settings where id='".$id."'";
    $outcome = mysql_query($sql);
    if (!$outcome) {
        appendlog("ERROR",$sql,mysql_error());
    }else{
        while ($row = mysql_fetch_assoc($outcome)){
            $settingValue=($row['value']);
        }
    }
    return $settingValue;
}

function setTemperature($value){
    // store the value in the databse issue #25
    // this code would be called by the crontab.php for regular update
    // and by the action.php for update thru the API.
    // in the crontab.php we would move the current code from getTemperature();
    
}


function getTemperature(){
    //return round( (0.5 + (2.5 - 0.5) * (mt_rand() / mt_getrandmax())), 1, PHP_ROUND_HALF_UP);
    
    // retrieve value in the databse issue #25
    // retrieve the temperature offset
    $tempOffset=getSetting("tempOffset");
    for ($i = 0; $i < 2; $i++){
        $v1 = round(readSensor(getDevice("temp")), 1,PHP_ROUND_HALF_UP)+$tempOffset;
        //$v1 = round(readSensorStream("usb2"), 1,PHP_ROUND_HALF_UP);  
        if ($v1>0 and $v1<50) return $v1;
    }
    return false;
}

function temperatureCompensation(){
    if (getSetting("tempCompensation")=="on"){  // check compensate setting in database
        $frame="T,".getTemperature()."\n";
        $result  = readSensor(getDevice("ph"),$frame);
        appendlog("COMPENSATE",$frame,$result);
    }    
}

// use "I" command to determine where PH and ORP and TEMP sensors are connected ttyUSB
function getPh(){
    //return round( (8.10 + (8.20 - 8.10) * (mt_rand() / mt_getrandmax())), 2, PHP_ROUND_HALF_UP);
    $offsetPH=getSetting("offsetPH");
    //temperatureCompensation();
    // we should only compensate uppon Ph Calibration
    for ($i = 0; $i < 2; $i++){
        $v1 = round(readSensor(getDevice("ph")), 2,PHP_ROUND_HALF_UP)+$offsetPH;  
        if ($v1>0 and $v1<10) return $v1;
    }
    return false;
}

function getORP(){
    //return intval(rand(633,640));
    
    // retrieve the offset
    $offsetORP=getSetting("offsetORP");
    
    for ($i = 0; $i < 2; $i++){
        $v1 = intval(readSensor(getDevice("orp")))+$offsetORP;      
        if ($v1>0 and $v1<1000) return $v1;
    }
    return false;    
}

function readSensorStream($device){
    $v1="ERR";
    //$v1=file_get_contents("/dev/ttyUSB2",$v1);
    //echo $v1;
    $filename = "/dev/ttyUSB2";
    $handle = fopen($filename, "r");
    $v1 = fread($handle);
    fclose($handle);
    return substr($v1,0,5);
}

function readSensor($device,$command="R\r"){
    $serial = new PhpSerial;
    $serial->deviceSet($device);
    $serial->confBaudRate(9600);
    $serial->deviceOpen();
    //sleep(2);
    $serial->sendMessage($command);
    sleep(1);
    $val=$serial->readPort();
    $serial->deviceClose();    
    return $val;  
}



function getPoolTemperature(){
    $temp=getTemperature();
    if ($temp==false) $temp=-99;
    $temp=intval($temp);
    if ($temp/2 <> intval($temp/2)) $temp-=1;
    $tempRange=$temp."to".($temp+2);
    if ($temp>=28) $tempRange="above28";
    if ($temp<0) $tempRange="below0";
    return $tempRange;
}

function secure($string){
	return htmlentities(($string),NULL,'UTF-8');
	//return htmlentities(stripslashes($string),NULL,'UTF-8');
}

function getCurrentTimeWindow(){
    // get the current hours and force multiple to 2
    $tw=getCurrentTime();
    //$tw=06; 
    if ($tw/2 <> intval($tw/2)) $tw-=1;
    // format to 2 digit (prefix 0) 
    $prefixDigit="";
    if (strlen($tw)<2) $prefixDigit="0";
    // convert to text with hour so it match the row name in table
    $tw=$prefixDigit.$tw;
    return $tw;
}

function getCurrentTime(){
    // get the current hours and force multiple to 2
    return date("H");
}

function getCurrentMinute(){
    // get the current hours and force multiple to 2
    return date("i");
}

function getCurrentTimeStamp(){
    return date('Y-m-d H:i:s');
}
//
// remove_comments will strip the sql comment lines out of an uploaded sql file
// specifically for mssql and postgres type files in the install....
//
function remove_comments(&$output)
{
   $lines = explode("\n", $output);
   $output = "";

   // try to keep mem. use down
   $linecount = count($lines);

   $in_comment = false;
   for($i = 0; $i < $linecount; $i++)
   {
      if( preg_match("/^\/\*/", preg_quote($lines[$i])) )
      {
         $in_comment = true;
      }

      if( !$in_comment )
      {
         $output .= $lines[$i] . "\n";
      }

      if( preg_match("/\*\/$/", preg_quote($lines[$i])) )
      {
         $in_comment = false;
      }
   }

   unset($lines);
   return $output;
}

//
// remove_remarks will strip the sql comment lines out of an uploaded sql file
//
function remove_remarks($sql)
{
   $lines = explode("\n", $sql);

   // try to keep mem. use down
   $sql = "";

   $linecount = count($lines);
   $output = "";

   for ($i = 0; $i < $linecount; $i++)
   {
      if (($i != ($linecount - 1)) || (strlen($lines[$i]) > 0))
      {
         if (isset($lines[$i][0]) && $lines[$i][0] != "#")
         {
            $output .= $lines[$i] . "\n";
         }
         else
         {
            $output .= "\n";
         }
         // Trading a bit of speed for lower mem. use here.
         $lines[$i] = "";
      }
   }

   return $output;

}

//
// split_sql_file will split an uploaded sql file into single sql statements.
// Note: expects trim() to have already been run on $sql.
//
function split_sql_file($sql, $delimiter)
{
   // Split up our string into "possible" SQL statements.
   $tokens = explode($delimiter, $sql);

   // try to save mem.
   $sql = "";
   $output = array();

   // we don't actually care about the matches preg gives us.
   $matches = array();

   // this is faster than calling count($oktens) every time thru the loop.
   $token_count = count($tokens);
   for ($i = 0; $i < $token_count; $i++)
   {
      // Don't wanna add an empty string as the last thing in the array.
      if (($i != ($token_count - 1)) || (strlen($tokens[$i] > 0)))
      {
         // This is the total number of single quotes in the token.
         $total_quotes = preg_match_all("/'/", $tokens[$i], $matches);
         // Counts single quotes that are preceded by an odd number of backslashes,
         // which means they're escaped quotes.
       $escaped_quotes = preg_match_all("/(?<!\\\\)(\\\\\\\\)*\\\\'/", $tokens[$i], $matches);

         $unescaped_quotes = $total_quotes - $escaped_quotes;

         // If the number of unescaped quotes is even, then the delimiter did NOT occur inside a string literal.
         if (($unescaped_quotes % 2) == 0)
         {
            // It's a complete sql statement.
            $output[] = $tokens[$i];
            // save memory.
            $tokens[$i] = "";
         }
         else
         {
            // incomplete sql statement. keep adding tokens until we have a complete one.
            // $temp will hold what we have so far.
            $temp = $tokens[$i] . $delimiter;
            // save memory..
            $tokens[$i] = "";

            // Do we have a complete statement yet?
            $complete_stmt = false;

            for ($j = $i + 1; (!$complete_stmt && ($j < $token_count)); $j++)
            {
               // This is the total number of single quotes in the token.
               $total_quotes = preg_match_all("/'/", $tokens[$j], $matches);
               // Counts single quotes that are preceded by an odd number of backslashes,
               // which means they're escaped quotes.
               $escaped_quotes = preg_match_all("/(?<!\\\\)(\\\\\\\\)*\\\\'/", $tokens[$j], $matches);

               $unescaped_quotes = $total_quotes - $escaped_quotes;

               if (($unescaped_quotes % 2) == 1)
               {
                  // odd number of unescaped quotes. In combination with the previous incomplete
                  // statement(s), we now have a complete statement. (2 odds always make an even)
                  $output[] = $temp . $tokens[$j];

                  // save memory.
                  $tokens[$j] = "";
                  $temp = "";

                  // exit the loop.
                  $complete_stmt = true;
                  // make sure the outer loop continues at the right point.
                  $i = $j;
               }
               else
               {
                  // even number of unescaped quotes. We still don't have a complete statement.
                  // (1 odd and 1 even always make an odd)
                  $temp .= $tokens[$j] . $delimiter;
                  // save memory.
                  $tokens[$j] = "";
               }

            } // for..
         } // else
      }
   }

   return $output;
}

?>