mirror/php-e107
1
0
Fork 0
mirror of https://github.com/e107inc/e107.git synced 2025-08-01 04:10:38 +02:00
Code Issues Releases Wiki Activity

Improved logging of the upgrade process.

Browse Source
This commit is contained in:
Cameron
2013-05-12 20:56:35 -07:00
parent c109689ac9
commit a9c43432cc
6 changed files with 264 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

186
e107_handlers/admin_log_class.php
View File

@@ -39,11 +39,19 @@ class e_admin_log
protected $_options = array('log_level'=>2, 'backtrace'=>false, );
protected $rldb = NULL; // Database used by logging routine
protected $logFile = null;
/**
* Log messages
* @var array
*/
protected $_messages;
protected $_messages;
protected $_allMessages; // similar to $_messages except it is never flushed.
/**
* Constructor. Sets up constants and overwrites default options where set.
@@ -91,10 +99,13 @@ class e_admin_log
// e107::getMessage(); - just include, message handler is creating session in construct
// it breaks stuff (see class2 - language detection and comments)
require_once(e_HANDLER.'message_handler.php');
$this->_messages = array();
$this->_messages = array();
$this->_allMessages = array();
}
/**
* @DEPRECATED
* BC Alias of add();
*/
public function log_event($event_title, $event_detail, $event_type = E_LOG_INFORMATIVE , $event_code = '')
@@ -231,16 +242,31 @@ class e_admin_log
$explain = $line;
unset($line);
}
$explain = mysql_real_escape_string($tp->toDB($explain, true, false, 'no_html'));
$event_title = $tp->toDB($event_title, true, false, 'no_html');
//---------------------------------------
// Admin Log
//---------------------------------------
if ($target_logs & LOG_TO_ADMIN)
{ // Admin log - assume all fields valid
$qry = " null, ".intval($time_sec).','.intval($time_usec).", '{$importance}', '{$eventcode}', {$userid}, '{$userIP}', '{$event_title}', '{$explain}' ";
$this->rldb->db_Insert("admin_log", $qry);
if ($target_logs & LOG_TO_ADMIN) // Admin log - assume all fields valid
{
// $qry = " null, ".intval($time_sec).','.intval($time_usec).", '{$importance}', '{$eventcode}', {$userid}, '{$userIP}', '{$event_title}', '{$explain}' ";
$adminLogInsert = array(
'dblog_id' => null,
'dblog_type' => $importance,
'dblog_eventcode' => $eventcode,
'dblog_datestamp' => time(),
'dblog_microtime' => intval($time_usec),
'dblog_user_id' => $userid,
'dblog_ip' => $userIP,
'dblog_title' => $event_title,
'dblog_remarks' => $explain
);
$this->rldb->db_Insert("admin_log", $adminLogInsert);
}
//---------------------------------------
@@ -413,7 +439,7 @@ class e_admin_log
}
if (count($changes))
{
if($logNow) $this->log_event($event, implode('[!br!]', $changes), E_LOG_INFORMATIVE, '');
if($logNow) $this->add($event, implode('[!br!]', $changes), E_LOG_INFORMATIVE, '');
else $this->logMessage(implode('[!br!]', $changes), LOG_MESSAGE_NODISPLAY, E_MESSAGE_INFO);
return TRUE;
}
@@ -453,7 +479,7 @@ class e_admin_log
}
$spacer = '[!br!]';
}
$this->log_event($event, $logString, E_LOG_INFORMATIVE, '');
$this->add($event, $logString, E_LOG_INFORMATIVE, '');
}
/**
@@ -476,24 +502,53 @@ class e_admin_log
{
if(empty($text)) return;
if(!$type) $type = E_MESSAGE_INFO;
if($logLevel === TRUE) $logLevel = $type;
$this->_messages[] = array('message' => $text, 'dislevel' => $type, 'loglevel' => $logLevel, 'session' => $session);
if($logLevel === TRUE) $logLevel = $type;
$logArray = array('message' => $text, 'dislevel' => $type, 'loglevel' => $logLevel, 'session' => $session, 'time'=>time());
$this->_messages[] = $logArray;
$this->_allMessages[] = $logArray;
return $this;
}
/**
* Log success
*
* @param string $text
* @param boolean $message if true - register with eMessage handler
* @param boolean $session add session message
* @return e_admin_log
*/
public function logSuccess($text, $message = true, $session = false)
/**
* @DEPRECATED
* BC Alias for addSuccess();
*/
public function logSuccess($text, $message = true, $session = false)
{
return $this->logMessage($text, ($message ? E_MESSAGE_SUCCESS : LOG_MESSAGE_NODISPLAY), E_MESSAGE_SUCCESS, $session);
return $this->addSuccess($text,$message,$session);
}
/**
* @DEPRECATED
* BC Alias for addError();
*/
public function logError($text, $message = true, $session = false)
{
return $this->addError($text,$message,$session);
}
/**
* Log success
*
* @param string $text
* @param boolean $message if true - register with eMessage handler
* @param boolean $session add session message
* @return e_admin_log
*/
public function addSuccess($text, $message = true, $session = false)
{
return $this->logMessage($text, ($message ? E_MESSAGE_SUCCESS : LOG_MESSAGE_NODISPLAY), E_MESSAGE_SUCCESS, $session);
}
/**
* Log error
*
@@ -502,11 +557,39 @@ class e_admin_log
* @param boolean $session add session message
* @return e_admin_log
*/
public function logError($text, $message = true, $session = false)
public function addError($text, $message = true, $session = false)
{
return $this->logMessage($text, ($message ? E_MESSAGE_ERROR : LOG_MESSAGE_NODISPLAY), E_MESSAGE_ERROR, $session);
}
/**
* Log Debug
*
* @param string $text
* @param boolean $message if true - register with eMessage handler
* @param boolean $session add session message
* @return e_admin_log
*/
public function addDebug($text, $message = true, $session = false)
{
return $this->logMessage($text, ($message ? E_MESSAGE_DEBUG : LOG_MESSAGE_NODISPLAY), E_MESSAGE_NOTICE, $session);
}
/**
* Log Warning
*
* @param string $text
* @param boolean $message if true - register with eMessage handler
* @param boolean $session add session message
* @return e_admin_log
*/
public function addWarning($text, $message = true, $session = false)
{
return $this->logMessage($text, ($message ? E_MESSAGE_WARNING : LOG_MESSAGE_NODISPLAY), E_MESSAGE_WARNING, $session);
}
/**
* Empty the messages - pass to both admin log and message handler
*
@@ -519,7 +602,7 @@ class e_admin_log
public function flushMessages($logTitle, $logImportance = E_LOG_INFORMATIVE, $logEventCode = '', $mstack = false)
{
$mes = e107::getMessage();
$resultTypes = array(E_MESSAGE_SUCCESS - 'Success', E_MESSAGE_ERROR => 'Fail'); // Add LANS here. Could add other codes
$separator = '';
$logString = '';
@@ -547,8 +630,63 @@ class e_admin_log
else $mes->add($m['message'], $m['dislevel'], $m['session']);
}
}
e107::getAdminLog()->log_event($logTitle, $logString, $logImportance, $logEventCode);
$this->_messages = array(); // Clear the memory for reuse
e107::getAdminLog()->add($logTitle, $logString, $logImportance, $logEventCode);
$this->_messages = array(); // Clear the memory for reuse
return $this;
}
/**
* Save Message stack to File.
*/
private function saveToFile($logTitle='')
{
if($this->logFile == null)
{
return;
}
$text = "";
if(count($this->_allMessages))
{
$text .= " e107 CMS Log file : ".$logTitle." ".date('Y-m-d_H-i-s')."\n";
$text .= "-------------------------------------------------------------------------------------------\n\n";
}
foreach($this->_allMessages as $m)
{
$text .= date('Y-m-d H:i:s',$m['time'])." \t".str_pad($m['dislevel'],10," ",STR_PAD_RIGHT)."\t".strip_tags($m['message'])."\n";
}
if(file_put_contents($this->logFile,$text))
{
$this->_allMessages = array();
return $this->logFile;
}
return false;
}
/**
* Set and enable logging to a file.
* Must be set PRIOR to flushMessages(). (which saves the results)
* @param name without the extension. (ie. data prefix and .log suffix will be added automatically)
*/
public function toFile($name,$logTitle='')
{
$date = date('Y-m-d_H-i-s');
$this->logFile = e_LOG.$date."_".$name.".log";
$this->saveToFile($logTitle);
$this->logFile = null;
}
}