File Source for LogUtil.class.php

<?php
/**
* Zikula Application Framework
*
* @copyright Robert Gasch
* @link http://www.zikula.org
* @version $Id: LogUtil.class.php 24342 2008-06-06 12:03:14Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @author Robert Gasch rgasch@gmail.com
* @package Zikula_Core
*/
/**
* LogUtil
*
* @package Zikula_Core
* @subpackage LogUtil
*/
class LogUtil
{
/**
* Returns an array of status messages
*
* @param $override whether to override status messages with error messages
* @return array of messages
*/
function getStatusMessages ($delete=true, $override=true, $reverse=true)
{
$msgs = SessionUtil::getVar('_PNStatusMsg', array());
$errs = SessionUtil::getVar('_PNErrorMsg', array());
if (!empty($errs) && $override) {
$msgs = $errs;
}
if ($delete) {
SessionUtil::delVar('_PNErrorMsg');
SessionUtil::delVar('_PNErrorMsgType');
SessionUtil::delVar('_PNStatusMsg');
SessionUtil::delVar('_PNStatusMsgType');
}
if ($reverse) {
$msgs = array_reverse($msgs, true);
}
return $msgs;
}
/**
* Returns a string of the available status messages, separated by the given delimeter
*
* @param $delimeter The string to use as the delimeter between the array of messages
* @param $override whether to override status messages with error messages
* @return string the generated error message
*/
function getStatusMessagesText ($delimeter=' ', $delete=true, $override=true)
{
$msgs = LogUtil::getStatusMessages ($delete, $override);
return implode ($delimeter, $msgs);
}
/**
* Get an array of error messages
*
* @return array of messages
*/
function getErrorMessages ($delete=true, $reverse=true)
{
$msgs = SessionUtil::getVar('_PNErrorMsg', array());
if ($delete) {
SessionUtil::delVar('_PNErrorMsg');
SessionUtil::delVar('_PNErrorMsgType');
}
if ($reverse) {
$msgs = array_reverse($msgs, true);
}
return $msgs;
}
/**
* Get an error message text
*
* @param $delimeter The string to use as the delimeter between the array of messages
* @return string the generated error message
*/
function getErrorMessagesText ($delimeter=' ', $delete=true)
{
$msgs = LogUtil::getErrorMessages ($delete);
return implode ($delimeter, $msgs);
}
/**
* get the error type
*
* @return int error type
*/
function getErrorType ()
{
return (int)SessionUtil::getVar('_PNErrorMsgType');
}
/**
* check if errors
*
* @return int error type
*/
function hasErrors ()
{
$msgs = LogUtil::getErrorMessages (false);
return (bool)!empty($msgs);
}
/**
* Set an error message text
*
* @param $message string the error message
* @return true
*/
function registerStatus ($message)
{
if (empty($message)) {
return pn_exit ('Empty message received ...');
}
$msgs = SessionUtil::getVar('_PNStatusMsg', array());
if (is_array($message)) {
$msgs = array_merge($msgs, $message);
} else {
$msgs[] = DataUtil::formatForDisplayHTML($message);
}
SessionUtil::setVar('_PNStatusMsg', $msgs);
return true;
}
/**
* Register a failed authid check. This method calls registerError and
* then redirects back to the specified URL.
*
* @param $url The URL to redirect to (optional) (default=null)
* @return false
*/
function registerAuthidError ($url=null)
{
return LogUtil::registerError (_BADAUTHKEY, null, $url);
}
/**
* Register a failed permission check. This method calls registerError and
* then logs the failed permission check so that it can be analyzed later.
*
* @param $url The URL to redirect to (optional) (default=null)
* @return false
*/
function registerPermissionError ($url=null)
{
static $strLevels = array();
if (!$strLevels) {
$strLevels[ACCESS_INVALID] = 'INVALID';
$strLevels[ACCESS_NONE] = 'NONE';
$strLevels[ACCESS_OVERVIEW] = 'OVERVIEW';
$strLevels[ACCESS_READ] = 'READ';
$strLevels[ACCESS_COMMENT] = 'COMMENT';
$strLevels[ACCESS_MODERATE] = 'MODERATE';
$strLevels[ACCESS_EDIT] = 'EDIT';
$strLevels[ACCESS_ADD] = 'ADD';
$strLevels[ACCESS_DELETE] = 'DELETE';
$strLevels[ACCESS_ADMIN] = 'ADMIN';
}
global $PNRuntime;
$obj = array();
$obj['component'] = 'PERMISSION';
$obj['sec_component'] = $PNRuntime['security']['last_failed_check']['component'];
$obj['sec_instance'] = $PNRuntime['security']['last_failed_check']['instance'];
$obj['sec_permission'] = $strLevels[$PNRuntime['security']['last_failed_check']['level']];
LogUtil::_write (_MODULENOAUTH, 'PERMISSION', $obj);
return LogUtil::registerError (_MODULENOAUTH, 403, $url);
}
/**
* Set an error message text. Also adds method, file and line where the error occured
*
* @param $message string the error message
* @param $type type of error (numeric and corresponding to a HTTP status code) (optional) (default=null)
* @param $url the url to redirect to (optional) (default=null)
* @return false
*/
function registerError ($message, $type=null, $url=null)
{
if (empty($message)) {
return pn_exit ('Empty message received ...');
}
global $PNConfig;
$showDetailInfo = (defined('_PNINSTALLVER') || ($PNConfig['System']['development'] && SecurityUtil::checkPermission('.*', '.*', ACCESS_ADMIN)));
if ($showDetailInfo) {
$bt = debug_backtrace();
$cf0 = $bt[0];
$cf1 = isset($bt[1]) ? $bt[1] : array('function' => '', 'args' => '');
$file = $cf0['file'];
$line = $cf0['line'];
$func = !empty($cf1['function']) ? '['.$cf1['function'].']' : '';
$args = $cf1['args'];
} else {
$func = '';
}
if (!$showDetailInfo) {
$msg = $message;
} else {
$msg = pnML('_ERROR_ADMIN', array('message' => $message, 'func' => $func, 'line' => $line, 'file' => $file), true);
if (defined('_PNINSTALLVER') && $PNConfig['System']['development']) {
$msg .= ' ';
$msg .= _prayer (debug_backtrace());
}
}
$msgs = SessionUtil::getVar('_PNErrorMsg', array());
// no html encoding should be used here - not htmlentities nor DataUtil methods
// as the message *may* contain pre-formatted html
if (is_array($message)) {
$msgs = array_merge($msgs, $message);
} else {
$msgs[] = $msg;
}
// note for bug #4439 - we dont want to pass messages through HTML tag
// filter, only ensure the HTML is valid since this is system generated
SessionUtil::setVar('_PNErrorMsg', $msgs);
// check if we've got an error type
if (isset($type) && is_numeric($type)) {
SessionUtil::setVar('_PNErrorMsgType', $type);
}
// check if we want to redirect
if ($url) {
return pnRedirect($url);
}
// since we're registering an error, it makes sense to return false here.
// This allows the calling code to just return the result of pnRegisterError
// if it wishes to return 'false' (which is what ususally happens).
return false;
}
/**
* Log the given messge under the given level
*
* @param msg The message to log
* @param level The log to log this message under
* @returns nothing
*/
function log ($msg, $level='DEFAULT')
{
global $PNConfig;
$haveConfig = count($PNConfig['Log']) > 0;
$logLevels = $PNConfig['Log']['log_levels'];
$showErrors = $PNConfig['Log']['log_show_errors'];
$logUser = $PNConfig['Log']['log_user'];
$suid = SessionUtil::getVar('uid', 0);
if ($logUser && $logUser != $suid) {
return;
}
if (!$haveConfig) {
print "Logging configuration can't be loaded .... logging is disabled";
}
elseif ($level == "ALL" && $showErrors == true) {
print "You should not add an event log with log_level 'ALL'";
}
elseif (in_array($level,$logLevels) || in_array("ALL",$logLevels)) {
LogUtil::_write($msg, $level);
}
}
/**
* Generate the filename of todays log file
*
* @returns the generated filename
*/
function getLogFileName ($level=null)
{
global $PNConfig;
$logfileSpec = $PNConfig['Log']['log_file'];
$dateFormat = $PNConfig['Log']['log_file_date_format'];
if ($level && isset($PNConfig['Log']['log_level_files'][$level]) && $PNConfig['Log']['log_level_files'][$level]) {
$logfileSpec = $PNConfig['Log']['log_level_files'][$level];
}
if (strpos($logfileSpec, "%s") !== false)
{
if ($PNConfig['Log']['log_file_uid'])
{
$perc = strpos ($logfileSpec, '%s');
$start = substr ($logfileSpec, 0, $perc+2);
$end = substr ($logfileSpec, $perc+2);
$uid = SessionUtil::getVar('uid', 0);
$logfileSpec = $start . '-%d' . $end;
$logfile = sprintf($logfileSpec, date($dateFormat), $uid);
}
else {
$logfile = sprintf($logfileSpec, date($dateFormat));
}
}
else {
$logfile = $logfileSpec;
}
return $logfile;
}
/**
* Write the error message to the log file.
*
* Prints log file full error (if $log_show_errors is true)
*
* @param msg The message to log
* @param level The log level to log this message under
*
* @returns Logging file write error (file or directory unwritable) (if $log_show_errors is true)
*/
function _write ($msg, $level='DEFAULT', $securityInfo=null)
{
global $PNConfig;
$logEnabled = $PNConfig['Log']['log_enabled'];
if (!$logEnabled) {
return;
}
$logShowErr = $PNConfig['Log']['log_show_errors'];
$logDateFmt = $PNConfig['Log']['log_date_format'];
$logDest = $PNConfig['Log']['log_dest'];
$uid = SessionUtil::getVar('uid', 1);
$module = pnModGetName();
$type = FormUtil::getPassedValue ('type', 'user', 'GETPOST');
$func = FormUtil::getPassedValue ('func', 'main', 'GETPOST');
if ($level && isset($PNConfig['Log']['log_level_dest'][$level]) && $PNConfig['Log']['log_level_dest'][$level]) {
$logDest = $PNConfig['Log']['log_level_dest'][$level];
}
// permission to be logged to DB or FILE
if ($level == 'PERMISSION' && ($logDest!='DB' && $logDest!='FILE')) {
$logDest = 'DB';
}
$logDest = strtoupper ($logDest);
$logline = '';
if ($logDest == 'FILE') {
$title = date($logDateFmt) . ", level=$level, uid=$uid, module=$module, type=$type, func=$func\n";
if ($securityInfo)
$title .= "++ sec_component=$securityInfo[sec_component], sec_instance=$securityInfo[sec_instance], sec_permission=$securityInfo[sec_permission]\n";
$logline = '+ ' . $title;
}
$logline .= "$msg\n\n";
if ($logDest == 'FILE')
{
static $logfile = '';
if (!$logfile) {
$logfile = LogUtil::getLogFileName($level);
}
$logfileOK = LogUtil::_checkLogFile($logfile, $level, $reason);
if ($logfileOK) {
$fp = fopen($logfile, 'a');
fwrite ($fp, $logline, strlen($logline));
fclose ($fp);
}
elseif ($logShowErr) {
if ($reason == 'NOWRITE') {
print "Logging Disabled. Log file ($logfile) unwritable.";
}
elseif ($reason == 'TOOBIG') {
print "Log file ($logfile) is full.";
}
}
}
elseif ($logDest == 'PRINT') {
print '<div class="pn-sub" style="text-align:left;">' . $logline . '</div>';
//print $msg;
}
elseif ($logDest == 'MAIL') {
$title = date($logDateFmt) . ", level=$level, uid=$uid\n";
$adminmail = pnConfigGetVar('adminmail');
$args = array();
$args['fromname'] = 'Zikula ' . pnConfigGetVar('slogan', 'Site Slogan');
$args['fromaddress'] = $adminmail;
$args['toname'] = 'Site Administrator';
$args['toaddress'] = $adminmail;
$args['subject'] = "Log Message: level=$level, uid=$uid";
$args['body'] = $logline;
$rc = pnModFunc ('Mailer', 'userapi', 'sendmessage', $args);
}
elseif ($logDest == 'DB') {
$obj = array();
$obj['date'] = date($logDateFmt);
$obj['uid'] = $uid;
$obj['component'] = $level;
$obj['module'] = $module;
$obj['type'] = $type;
$obj['function'] = $func;
$obj['message'] = $msg;
if ($securityInfo && is_array($securityInfo)) {
$obj = array_merge ($obj, $securityInfo);
}
if (pnModDBInfoLoad ('SecurityCenter')) {
if (!DBUtil::insertObject ($obj, 'sc_logevent')) {
print '<div class="pn-sub" style="text-align:left;">';
print 'Failed to insert log record into log_event table ';
prayer ($obj);
print '</div>';
}
} else {
print 'Failed to load logging table definition from SecurityCenter module ';
}
} else {
print "Unknown log destination [$logDest] ... ";
}
}
/**
* Check the log file is writable and not full.
*
* returns unwritable The file or directory cannot be written to
* returns toobig The log file size is bigger than $log_length in logging.conf.php.
*
* @returns boolean Whether or not the file is ready for writing
*/
function _checkLogFile($logfile, $level, &$reason)
{
global $PNConfig;
$logSize = $PNConfig['Log']['log_maxsize'];
if (!$logfile) {
$logfile = LogUtil::getLogFileName($level);
}
$size = 0;
$rc = false;
if (file_exists($logfile)) {
$size = filesize($logfile) / 1024 / 1024;
}
if (file_exists($logfile) && is_writable($logfile)) {
$rc = true;
}
elseif (!file_exists($logfile))
{
@touch ($logfile);
if (file_exists($logfile)) {
chmod ($logfile, 0755);
$rc = true;
} else {
SessionUtil::setVar('_PNStatusMsg', "Unable to create log file [$logfile] ...");
$reason = 'NOWRITE';
}
} elseif ($logSize && $size > $logSize) {
SessionUtil::setVar('_PNStatusMsg', "Logfile [$logfile] size [$size] exceeds [$logSize] ...");
$reason = 'TOOBIG';
}
return $rc;
}
/**
* Cleans up unneeded old log files
*
*/
function _cleanLogFiles()
{
if (defined('_PNINSTALLVER')) {
return;
}
global $PNConfig;
$oneday = 24 * 60 * 60;
$log_keep_days = $PNConfig['Log']['log_keep_days'];
if (!$log_keep_days) $log_keep_days = 30; // temporary default value for migration
$log_keep_seconds = $log_keep_days * $oneday;
$lastcheck = pnConfigGetVar('log_last_rotate');
$currenttime = time();
if (time() - $lastcheck > $oneday) {
// check once a day
Loader::loadClass('FileUtil');
$logfilepath = $PNConfig['Log']['log_dir'];
$logfiles = FileUtil::getFiles($logfilepath, false, false);
foreach($logfiles as $logfile) {
if ($currenttime - filemtime($logfile) > $log_keep_seconds) {
unlink($logfile);
}
}
pnConfigSetVar('log_last_rotate', $currenttime);
}
}
}

Source for file LogUtil.class.php