This class handles messages appearing while calling API functions of AlternC
* Those messages are stored as a number (class-id) and a message
* localized messages are available
* This class also handle inserting those messages into the logging
* system in /var/log/alternc/bureau.log
*
*
* @copyright AlternC-Team https://alternc.com/
*/
class m_messages {
/** Contains the messages and their ID */
var $arrMessages = array();
var $logfile = "/var/log/alternc/bureau.log";
/** List of possible message types */
var $ARRTYPES = array("ERROR", "ALERT", "INFO", "OK");
/** CSS classes for each type */
var $ARRCSS = array(
"ERROR" => "alert-danger",
"ALERT" => "alert-warning",
"INFO" => "alert-info",
"OK" => "alert-success"
);
public function __construct() {
$this->init_msgs();
}
/**
* Record a message, insert it into the logfile.
*
* This function records a message, add it to the logfile,
* and make it available for the web panel to print it later.
*
* @param string $cat The category of the msg array to work with
* @param integer $clsid Which class raises this message
* @param mixed $msg The message
* @param string $param Non-mandatory string parameter for this message
* @return boolean TRUE if the message got recorded, FALSE if not.
*
*/
function raise($cat = "Error", $clsid, $msg, $param = "") {
$arrInfos = array();
$type = strtoupper($cat);
if (! in_array($type, $this->ARRTYPES)) {
return false;
}
$arrInfos['clsid'] = $clsid;
$arrInfos['msg'] = $msg;
$arrInfos['param'] = is_array($param)?$param:(empty($param)?"":array($param));
$this->arrMessages[$type][] = $arrInfos;
$this->logAlternC($cat);
return true;
}
/**
* Reset the stored messages array
*/
function init_msgs() {
foreach ($this->ARRTYPES as $v) {
$this->arrMessages[$v] = array();
}
}
/**
* Tell if there are stored messages for a specific level
* or for all levels (if level is empty)
*
* @param string $cat The level of the msg array to work with
* @return boolean TRUE if there is/are msg recorded.
*
*/
function has_msgs($cat) {
$type = strtoupper($cat);
if (in_array($type, $this->ARRTYPES)) {
return (count($this->arrMessages[$type]) > 0);
} else {
foreach ($this->arrMessages as $v) {
if (count($v) > 0)
return true;
}
return false;
}
}
/**
* Return a string of concateneted messages of all recorded messages
* or only the last message
*
* @param string $cat The level of the msg array to work with
* @param string $sep The separator used to concatenate msgs
* @param boolean $all show all the messages or only the last one
*
* @return string Message.
*
*/
function msg_str($cat = "Error", $sep = "", $all = true) {
$str = "";
$type = strtoupper($cat);
if (! in_array($type, $this->ARRTYPES)) {
return false;
}
if (! $this->has_msgs($cat))
return "";
if ($all) {
foreach ($this->arrMessages[$type] as $k => $arrMsg) {
$args = $arrMsg['param'];
if (is_array($args) && count($args) > 0) {
array_unshift($args, $arrMsg['msg']);
if ($sep == "")
$str .= "" . call_user_func_array("sprintf", $args) . "";
else
$str .= call_user_func_array("sprintf", $args) . $sep;
} else
if ($sep == "")
$str .= "" . $arrMsg['msg'] . "";
else
$str .= $arrMsg['msg'] . $sep;
}
if ($sep == "")
$str = "";
} else {
$i = count($this->arrMessages[$type]) - 1;
if ($i > 0) {
$arr_msg=$this->arrMessages[$type][$i];
$args = $arr_msg['param'];
if (is_array($args) && count($args) > 0) {
array_unshift($args, $arr_msg['msg']);
$str = call_user_func_array("sprintf", $args);
} else
$str = $arr_msg['msgId'];
}
}
return $str;
}
/**
* Return a message in HTML form with associated CSS
*
* @param string $cat The level of the msg array to work with
* @param string $sep The separator used to concatenate msgs
* @param boolean $all show all the messages or only the last one
*
* @return string HTML message
*/
function msg_html($cat = "Error", $sep = "", $all = true) {
$type = strtoupper($cat);
if (! in_array($type, $this->ARRTYPES)) {
return false;
}
if (count($this->arrMessages[$type]) == 0)
return "";
$str = $this->msg_str($cat, $sep, $all);
$str = "" . $str . "
";
return $str;
}
/**
* Return all the messages of all levels in HTML form with associated CSS
*
* @param string $sep The separator used to concatenate msgs
* @param boolean $all show all the messages or only the last one
*
* @return string HTML message
*/
function msg_html_all($sep = "", $all = true, $init = false) {
$msg="";
$msg.=$this->msg_html("Error", $sep, $all);
$msg.=$this->msg_html("Ok", $sep, $all);
$msg.=$this->msg_html("Info", $sep, $all);
$msg.=$this->msg_html("Alert", $sep, $all);
if ($init)
$this->init_msgs();
return $msg;
}
/**
* Log a message into /var/log/alternc/bureau.log
*
* This function logs the last message in the /var/log/alternc folder
* allowing sysadmins to know what's happened.
* automatically called by raise()
* @access private
*/
function logAlternC($cat = "Error") {
global $mem;
$type = strtoupper($cat);
if (! in_array($type, $this->ARRTYPES)) {
return false;
}
@file_put_contents($this->logfile, date("d/m/Y H:i:s") . " - " . get_remote_ip() . " - $type - " . $mem->user["login"] . " - " . $this->msg_str($cat, "", false), FILE_APPEND);
}
/**
* Log an API function call into /var/log/alternc/bureau.log
*
* This function logs in /var/log/alternc an API function call of AlternC
*
* @param integer $clsid Number of the class doing the call
* @param string $function Name of the called function
* @param string $param non-mandatory parameters of the API call
* @return boolean TRUE if the log where successfull, FALSE if not
*
*/
function log($clsid, $function, $param = "") {
global $mem;
return @file_put_contents($this->logfile, date("d/m/Y H:i:s") . " - " . get_remote_ip() . " - CALL - " . $mem->user["login"] . " - $clsid - $function - $param\n", FILE_APPEND);
}
}
/* Class m_messages */