Collaboration diagram for SimpleSAML\Logger:

Static Public Member Functions
static	emergency ($string)

static	critical ($string)

static	alert ($string)

static	error ($string)

static	warning ($string)

static	notice ($string)

static	info ($string)

static	debug ($string)

static	stats ($string)

static	setCaptureLog ($val=true)

static	getCapturedLog ()
	Get the captured log. More...

static	setTrackId ($trackId)
	Set the track identifier to use in all logs. More...

static	flush ()
	Flush any pending log messages to the logging handler. More...

static	isErrorMasked ($errno)
	Evaluate whether errors of a certain error level are masked or not. More...

static	maskErrors ($mask)
	Disable error reporting for the given log levels. More...

static	popErrorMask ()
	Pop an error mask. More...

Data Fields
const	NO_TRACKID = '_NOTRACKIDYET_'
	This constant defines the string we set the track ID to while we are fetching the track ID from the session class. More...

const	EMERG = 0

const	ALERT = 1

const	CRIT = 2

const	ERR = 3

const	WARNING = 4

const	NOTICE = 5

const	INFO = 6

const	DEBUG = 7

Static Private Member Functions
static	defer ($level, $message, $stats)
	Defer a message for later logging. More...

static	createLoggingHandler ($handler=null)

static	log ($level, $string, $statsLog=false)

Static Private Attributes
static	$loggingHandler = null

static	$logLevel = null

static	$captureLog = false

static	$capturedLog = array()

static	$earlyLog = array()

static	$logLevelStack = array()

static	$logMask = 0

static	$trackid = self::NO_TRACKID
	This variable holds the track ID we have retrieved from the session class. More...

static	$format = '%date{%b %d %H:%M:%S} %process %level %stat[%trackid] %msg'

static	$shutdownRegistered = false

static	$shuttingDown = false

Detailed Description

Definition at line 13 of file Logger.php.

Member Function Documentation

◆ alert()

static SimpleSAML\Logger::alert ( $string )

static

Definition at line 155 of file Logger.php.

    {
        self::log(self::ALERT, $string);
    }

Referenced by SAML2\Compat\Ssp\Logger\alert(), and SAML2\Compat\Ssp\Logger\log().

Here is the caller graph for this function:

◆ createLoggingHandler()

static SimpleSAML\Logger::createLoggingHandler ( $handler = null )

staticprivate

Definition at line 350 of file Logger.php.

    {
        // set to false to indicate that it is being initialized
        self::$loggingHandler = false;
 
        // a set of known logging handlers
        $known_handlers = array(
            'syslog'   => 'SimpleSAML\Logger\SyslogLoggingHandler',
            'file'     => 'SimpleSAML\Logger\FileLoggingHandler',
            'errorlog' => 'SimpleSAML\Logger\ErrorLogLoggingHandler',
        );
 
        // get the configuration
        $config = \SimpleSAML_Configuration::getInstance();
        assert($config instanceof \SimpleSAML_Configuration);
 
        // setting minimum log_level
        self::$logLevel = $config->getInteger('logging.level', self::INFO);
 
        // get the metadata handler option from the configuration
        if (is_null($handler)) {
            $handler = $config->getString('logging.handler', 'syslog');
        }
 
        if (!array_key_exists($handler, $known_handlers) && class_exists($handler)) {
            if (!in_array('SimpleSAML\Logger\LoggingHandlerInterface', class_implements($handler), true)) {
                throw new \Exception("The logging handler '$handler' is invalid.");
            }
        } else {
            $handler = strtolower($handler);
            if (!array_key_exists($handler, $known_handlers)) {
                throw new \Exception(
                    "Invalid value for the 'logging.handler' configuration option. Unknown handler '".$handler."''."
                );
            }
            $handler = $known_handlers[$handler];
        }
        self::$loggingHandler = new $handler($config);
 
        self::$format = $config->getString('logging.format', self::$format);
        self::$loggingHandler->setLogFormat(self::$format);
    }

References $config, $format, $handler, and SimpleSAML_Configuration\getInstance().

Here is the call graph for this function:

◆ critical()

static SimpleSAML\Logger::critical ( $string )

static

Definition at line 144 of file Logger.php.

    {
        self::log(self::CRIT, $string);
    }

Referenced by SAML2\Compat\Ssp\Logger\critical(), SimpleSAML\Locale\Localization\getLangPath(), and SAML2\Compat\Ssp\Logger\log().

Here is the caller graph for this function:

◆ debug()

static SimpleSAML\Logger::debug ( $string )

static

Definition at line 211 of file Logger.php.

    {
        self::log(self::DEBUG, $string);
    }

References DEBUG.

Referenced by SimpleSAML_Auth_LDAP\__construct(), SimpleSAML_Auth_ProcessingChain\__construct(), sspmod_ldap_Auth_Process_BaseFilter\__construct(), SimpleSAML\Locale\Localization\addDomain(), sspmod_negotiate_Auth_Source_Negotiate\adminBind(), sspmod_authlinkedin_Auth_Source_LinkedIn\authenticate(), sspmod_authtwitter_Auth_Source_Twitter\authenticate(), sspmod_authwindowslive_Auth_Source_LiveID\authenticate(), sspmod_negotiate_Auth_Source_Negotiate\authenticate(), SimpleSAML_Auth_LDAP\bind(), sspmod_statistics_AccessCheck\checkAccess(), sspmod_negotiate_Auth_Source_Negotiate\checkMask(), sspmod_saml_Message\checkSign(), SimpleSAML\Store\SQL\cleanKVStore(), sspmod_saml_SP_LogoutStore\cleanLogoutStore(), sspmod_authfacebook_Facebook\clearPersistentData(), SimpleSAML_Auth_State\cloneState(), SAML2\Compat\Ssp\Logger\debug(), SimpleSAML\Utils\XML\debugSAMLMessage(), sspmod_saml_Message\decryptAssertion(), sspmod_saml_Message\decryptAttributes(), SimpleSAML_Memcache\delete(), sspmod_consent_Consent_Store_Database\deleteAllConsents(), sspmod_consent_Consent_Store_Database\deleteConsent(), SimpleSAML_Session\doLogin(), SimpleSAML_Session\doLogout(), sspmod_negotiate_Auth_Source_Negotiate\fallBack(), sspmod_authfacebook_Auth_Source_Facebook\finalStep(), sspmod_authlinkedin_Auth_Source_LinkedIn\finalStep(), sspmod_authtwitter_Auth_Source_Twitter\finalStep(), sspmod_authwindowslive_Auth_Source_LiveID\finalStep(), SimpleSAML_Memcache\get(), sspmod_oauth_Consumer\getAccessToken(), SimpleSAML_Auth_LDAP\getAttributes(), SimpleSAML\Metadata\Sources\MDQ\getFromCache(), sspmod_ldap_Auth_Process_AttributeAddUsersGroups\getGroups(), sspmod_ldap_Auth_Process_AttributeAddUsersGroups\getGroupsActiveDirectory(), sspmod_ldap_Auth_Process_AttributeAddUsersGroups\getGroupsOpenLdap(), sspmod_saml_Auth_Source_SP\getIdPMetadata(), SimpleSAML\Locale\Localization\getLangPath(), sspmod_ldap_Auth_Process_BaseFilter\getLdap(), sspmod_authfacebook_Facebook\getPersistentData(), sspmod_saml_Auth_Process_SQLPersistentNameID\getValue(), sspmod_consent_Consent_Store_Cookie\hasConsent(), sspmod_consent_Consent_Store_Database\hasConsent(), SimpleSAML\Locale\Translate\includeInlineTranslation(), SimpleSAML\Locale\Translate\includeLanguageFile(), sspmod_authfacebook_Facebook\initSharedSession(), SimpleSAML_Session\isValid(), sspmod_metarefresh_MetaLoader\loadSource(), SimpleSAML_Auth_State\loadState(), SAML2\Compat\Ssp\Logger\log(), SimpleSAML_Error_Exception\logDebug(), sspmod_authcrypt_Auth_Source_Hash\login(), sspmod_authcrypt_Auth_Source_Htpasswd\login(), sspmod_negotiate_Auth_Source_Negotiate\logout(), sspmod_negotiate_Auth_Source_Negotiate\lookupUserData(), metarefresh_hook_cron(), SimpleSAML\Module\core\Auth\Process\AttributeValueMap\process(), sspmod_core_Auth_Process_Cardinality\process(), sspmod_core_Auth_Process_CardinalitySingle\process(), sspmod_core_Auth_Process_GenerateGroups\process(), sspmod_core_Auth_Process_LanguageAdaptor\process(), sspmod_core_Auth_Process_ScopeFromAttribute\process(), sspmod_ldap_Auth_Process_AttributeAddUsersGroups\process(), sspmod_authYubiKey_Auth_Process_OTP2YubiPrefix\process(), sspmod_consent_Auth_Process_Consent\process(), sspmod_saml_Message\processAssertion(), SimpleSAML\Locale\Translate\readDictionaryFile(), sspmod_saml_Auth_Source_SP\reauthLogout(), SimpleSAML\Module\cron\Cron\runTag(), sspmod_consent_Consent_Store_Cookie\saveConsent(), sspmod_consent_Consent_Store_Database\saveConsent(), SimpleSAML_Metadata_MetaDataStorageHandlerSerialize\saveMetadata(), SimpleSAML_Auth_State\saveState(), SimpleSAML_Auth_LDAP\search(), sspmod_ldap_Auth_Process_AttributeAddUsersGroups\search(), sspmod_ldap_Auth_Process_AttributeAddUsersGroups\searchActiveDirectory(), SimpleSAML_Auth_LDAP\searchfordn(), SimpleSAML_XHTML_EMail\send(), sspmod_saml_IdP_SAML2\sendLogoutResponse(), SimpleSAML_Memcache\set(), SimpleSAML_Auth_LDAP\setOption(), sspmod_authfacebook_Facebook\setPersistentData(), SimpleSAML\Locale\Localization\setupL10N(), sspmod_negotiate_Auth_Source_Negotiate\spDisabledInMetadata(), sspmod_saml_Auth_Source_SP\startSSO1(), sspmod_saml_Auth_Source_SP\startSSO2(), SimpleSAML\XML\Validator\validateCertificate(), SimpleSAML_Metadata_SAMLParser\validateFingerprint(), SimpleSAML_Metadata_SAMLParser\validateSignature(), sspmod_metarefresh_MetaLoader\writeState(), and SimpleSAML\Metadata\Sources\MDQ\writeToCache().

Here is the caller graph for this function:

◆ defer()

static SimpleSAML\Logger::defer	(	$level,
		$message,
		$stats
	)

staticprivate

Defer a message for later logging.

Parameters

int	$level	The log level corresponding to this message.
string	$message	The message itself to log.
boolean	$stats	Whether this is a stats message or a regular one.

Definition at line 337 of file Logger.php.

    {
        // save the message for later
        self::$earlyLog[] = array('level' => $level, 'string' => $message, 'statsLog' => $stats);
 
        // register a shutdown handler if needed
        if (!self::$shutdownRegistered) {
            register_shutdown_function(array('SimpleSAML\Logger', 'flush'));
            self::$shutdownRegistered = true;
        }
    }

References $message, and Sabre\VObject\$stats.

◆ emergency()

static SimpleSAML\Logger::emergency ( $string )

static

Definition at line 133 of file Logger.php.

    {
        self::log(self::EMERG, $string);
    }

Referenced by SAML2\Compat\Ssp\Logger\emergency(), and SAML2\Compat\Ssp\Logger\log().

Here is the caller graph for this function:

◆ error()

static SimpleSAML\Logger::error ( $string )

static

Definition at line 166 of file Logger.php.

    {
        self::log(self::ERR, $string);
    }

Referenced by sspmod_consent_Auth_Process_Consent\__construct(), sspmod_saml_Auth_Process_ExpectedAuthnContextClassRef\__construct(), sspmod_consent_Consent_Store_Database\_execute(), sspmod_negotiate_Auth_Source_Negotiate\adminBind(), sspmod_authX509_Auth_Source_X509userCert\authenticate(), sspmod_negotiate_Auth_Source_Negotiate\authenticate(), SimpleSAML_Metadata_MetaDataStorageHandlerSerialize\deleteMetadata(), SimpleSAML_Session\doLogin(), SAML2\Compat\Ssp\Logger\error(), sspmod_saml_IdP_SAML2\generateNameIdValue(), SimpleSAML\Locale\Language\getInstalledLanguages(), SimpleSAML\Locale\Localization\getLangPath(), SimpleSAML\Locale\Language\getLanguageLocalizedName(), SimpleSAML_Session\getSessionFromRequest(), SimpleSAML\Store\SQL\insertOrUpdate(), SimpleSAML\Module\isModuleEnabledWithConf(), SimpleSAML\Locale\Localization\loadGettextGettextFromPO(), SAML2\Compat\Ssp\Logger\log(), SimpleSAML_Error_Exception\logError(), SimpleSAML_Auth_LDAP\makeException(), sspmod_authX509_Auth_Process_ExpiryWarning\process(), sspmod_consent_Auth_Process_Consent\process(), sspmod_expirycheck_Auth_Process_ExpiryDate\process(), sspmod_saml_IdP_SAML2\processSOAPAuthnRequest(), SimpleSAML\Locale\Translate\readDictionaryFile(), SimpleSAML\Locale\Translate\readDictionaryJSON(), SimpleSAML_Session\save(), SimpleSAML_Error_Error\saveError(), SimpleSAML_Metadata_MetaDataStorageHandlerSerialize\saveMetadata(), and sspmod_saml_Auth_Process_ExpectedAuthnContextClassRef\unauthorized().

Here is the caller graph for this function:

◆ flush()

static SimpleSAML\Logger::flush ( )

static

Flush any pending log messages to the logging handler.

This method is intended to be registered as a shutdown handler, so that any pending messages that weren't sent to the logging handler at that point, can still make it. It is therefore not intended to be called manually.

Definition at line 266 of file Logger.php.

    {
        try {
            $s = \SimpleSAML_Session::getSessionFromRequest();
        } catch (\Exception $e) {
            // loading session failed. We don't care why, at this point we have a transient session, so we use that
            self::error('Cannot load or create session: '.$e->getMessage());
            $s = \SimpleSAML_Session::getSessionFromRequest();
        }
        self::$trackid = $s->getTrackID();
 
        self::$shuttingDown = true;
        foreach (self::$earlyLog as $msg) {
            self::log($msg['level'], $msg['string'], $msg['statsLog']);
        }
    }

References $s, error(), and SimpleSAML_Session\getSessionFromRequest().

Here is the call graph for this function:

◆ getCapturedLog()

static SimpleSAML\Logger::getCapturedLog ( )

static

Get the captured log.

Definition at line 242 of file Logger.php.

    {
        return self::$capturedLog;
    }

◆ info()

static SimpleSAML\Logger::info ( $string )

static

Definition at line 199 of file Logger.php.

    {
        self::log(self::INFO, $string);
    }

Here is the caller graph for this function:

◆ isErrorMasked()

static SimpleSAML\Logger::isErrorMasked ( $errno )

static

Evaluate whether errors of a certain error level are masked or not.

Parameters

int $errno The level of the error to check.

Returns: bool True if the error is masked, false otherwise.

Definition at line 291 of file Logger.php.

    {
        return ($errno & self::$logMask) || !($errno & error_reporting());
    }

◆ log()

static SimpleSAML\Logger::log	(	$level,
		$string,
		$statsLog = `false`
	)

staticprivate

Definition at line 394 of file Logger.php.

    {
        if (self::$loggingHandler === false) {
            // some error occurred while initializing logging
            self::defer($level, $string, $statsLog);
            return;
        } elseif (php_sapi_name() === 'cli' || defined('STDIN')) {
            // we are being executed from the CLI, nowhere to log
            if (is_null(self::$loggingHandler)) {
                self::createLoggingHandler('SimpleSAML\Logger\StandardErrorLoggingHandler');
            }
            $_SERVER['REMOTE_ADDR'] = "CLI";
            if (self::$trackid === self::NO_TRACKID) {
                self::$trackid = 'CL'.bin2hex(openssl_random_pseudo_bytes(4));
            }
        } elseif (self::$loggingHandler === null) {
            // Initialize logging
            self::createLoggingHandler();
 
            if (!empty(self::$earlyLog)) {
                // output messages which were logged before we properly initialized logging
                foreach (self::$earlyLog as $msg) {
                    self::log($msg['level'], $msg['string'], $msg['statsLog']);
                }
            }
        }
 
        if (self::$captureLog) {
            $ts = microtime(true);
            $msecs = (int) (($ts - (int) $ts) * 1000);
            $ts = gmdate('H:i:s', $ts).sprintf('.%03d', $msecs).'Z';
            self::$capturedLog[] = $ts.' '.$string;
        }
 
        if (self::$logLevel >= $level || $statsLog) {
            if (is_array($string)) {
                $string = implode(",", $string);
            }
 
            $formats = array('%trackid', '%msg', '%srcip', '%stat');
            $replacements = array(self::$trackid, $string, $_SERVER['REMOTE_ADDR']);
 
            $stat = '';
            if ($statsLog) {
                $stat = 'STAT ';
            }
            array_push($replacements, $stat);
 
            if (self::$trackid === self::NO_TRACKID && !self::$shuttingDown) {
                // we have a log without track ID and we are not still shutting down, so defer logging
                self::defer($level, $string, $statsLog);
                return;
            } elseif (self::$trackid === self::NO_TRACKID) {
                // shutting down without a track ID, prettify it
                array_shift($replacements);
                array_unshift($replacements, 'N/A');
            }
 
            // we either have a track ID or we are shutting down, so just log the message
            $string = str_replace($formats, $replacements, self::$format);
            self::$loggingHandler->log($level, $string);
        }
    }

References $_SERVER, $format, and $formats.

◆ maskErrors()

static SimpleSAML\Logger::maskErrors ( $mask )

static

Disable error reporting for the given log levels.

Every call to this function must be followed by a call to popErrorMask().

Parameters

int $mask The log levels that should be masked.

Definition at line 304 of file Logger.php.

    {
        assert(is_int($mask));
 
        $currentEnabled = error_reporting();
        self::$logLevelStack[] = array($currentEnabled, self::$logMask);
 
        $currentEnabled &= ~$mask;
        error_reporting($currentEnabled);
        self::$logMask |= $mask;
    }

References $mask.

Referenced by SimpleSAML\Utils\Time\initTimezone(), SimpleSAML\Utils\Config\Metadata\isHiddenFromDiscovery(), and SimpleSAML_Utilities\maskErrors().

Here is the caller graph for this function:

◆ notice()

static SimpleSAML\Logger::notice ( $string )

static

Definition at line 188 of file Logger.php.

    {
        self::log(self::NOTICE, $string);
    }

Referenced by sspmod_saml_Message\checkSign(), SAML2\Compat\Ssp\Logger\log(), SAML2\Compat\Ssp\Logger\notice(), sspmod_ldap_Auth_Process_AttributeAddUsersGroups\searchActiveDirectory(), and statistics_hook_cron().

Here is the caller graph for this function:

◆ popErrorMask()

static SimpleSAML\Logger::popErrorMask ( )

static

Pop an error mask.

This function restores the previous error mask.

Definition at line 322 of file Logger.php.

    {
        $lastMask = array_pop(self::$logLevelStack);
        error_reporting($lastMask[0]);
        self::$logMask = $lastMask[1];
    }

Referenced by SimpleSAML\Utils\Time\initTimezone(), SimpleSAML\Utils\Config\Metadata\isHiddenFromDiscovery(), and SimpleSAML_Utilities\popErrorMask().

Here is the caller graph for this function:

◆ setCaptureLog()

static SimpleSAML\Logger::setCaptureLog ( $val = true )

static

Definition at line 233 of file Logger.php.

    {
        self::$captureLog = $val;
    }

◆ setTrackId()

static SimpleSAML\Logger::setTrackId ( $trackId )

static

Set the track identifier to use in all logs.

Parameters

$trackId string The track identifier to use during this session.

Definition at line 253 of file Logger.php.

    {
        self::$trackid = $trackId;
    }

Referenced by SimpleSAML_Session\__construct(), and SimpleSAML_Session\load().

Here is the caller graph for this function:

◆ stats()

static SimpleSAML\Logger::stats ( $string )

static

Definition at line 222 of file Logger.php.

    {
        self::log(self::NOTICE, $string, true);
    }

Referenced by sspmod_core_Auth_UserPassBase\handleLogin(), sspmod_consent_Auth_Process_Consent\process(), sspmod_core_Auth_Process_StatisticsWithAttribute\process(), and sspmod_saml_IdP_SAML2\receiveLogoutMessage().

Here is the caller graph for this function:

◆ warning()

static SimpleSAML\Logger::warning ( $string )

static

Definition at line 177 of file Logger.php.

    {
        self::log(self::WARNING, $string);
    }

Here is the caller graph for this function:

Field Documentation

◆ $capturedLog

SimpleSAML\Logger::$capturedLog = array()

staticprivate

Definition at line 34 of file Logger.php.

◆ $captureLog

SimpleSAML\Logger::$captureLog = false

staticprivate

Definition at line 29 of file Logger.php.

◆ $earlyLog

SimpleSAML\Logger::$earlyLog = array()

staticprivate

Definition at line 41 of file Logger.php.

◆ $format

SimpleSAML\Logger::$format = '%date{%b %d %H:%M:%S} %process %level %stat[%trackid] %msg'

staticprivate

Definition at line 102 of file Logger.php.

◆ $loggingHandler

SimpleSAML\Logger::$loggingHandler = null

staticprivate

Definition at line 19 of file Logger.php.

◆ $logLevel

SimpleSAML\Logger::$logLevel = null

staticprivate

Definition at line 24 of file Logger.php.

◆ $logLevelStack

SimpleSAML\Logger::$logLevelStack = array()

staticprivate

Definition at line 50 of file Logger.php.

◆ $logMask

SimpleSAML\Logger::$logMask = 0

staticprivate

Definition at line 59 of file Logger.php.

◆ $shutdownRegistered

SimpleSAML\Logger::$shutdownRegistered = false

staticprivate

Definition at line 109 of file Logger.php.

◆ $shuttingDown

SimpleSAML\Logger::$shuttingDown = false

staticprivate

Definition at line 116 of file Logger.php.

◆ $trackid

SimpleSAML\Logger::$trackid = self::NO_TRACKID

staticprivate

This variable holds the track ID we have retrieved from the session class.

It can also be NULL, in which case we haven't fetched the track ID yet, or self::NO_TRACKID, which means that we are fetching the track ID now.

Definition at line 72 of file Logger.php.

◆ ALERT

const SimpleSAML\Logger::ALERT = 1

Definition at line 119 of file Logger.php.

◆ CRIT

const SimpleSAML\Logger::CRIT = 2

Definition at line 120 of file Logger.php.

◆ DEBUG

const SimpleSAML\Logger::DEBUG = 7

Definition at line 125 of file Logger.php.

◆ EMERG

const SimpleSAML\Logger::EMERG = 0

Definition at line 118 of file Logger.php.

◆ ERR

const SimpleSAML\Logger::ERR = 3

Definition at line 121 of file Logger.php.

◆ INFO

const SimpleSAML\Logger::INFO = 6

Definition at line 124 of file Logger.php.

◆ NO_TRACKID

const SimpleSAML\Logger::NO_TRACKID = '_NOTRACKIDYET_'

This constant defines the string we set the track ID to while we are fetching the track ID from the session class.

This is used to prevent infinite recursion.

Definition at line 66 of file Logger.php.

◆ NOTICE

const SimpleSAML\Logger::NOTICE = 5

Definition at line 123 of file Logger.php.

◆ WARNING

const SimpleSAML\Logger::WARNING = 4

Definition at line 122 of file Logger.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Logger.php

Static Public Member Functions

Data Fields

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ alert()

◆ createLoggingHandler()

◆ critical()

◆ debug()

◆ defer()

◆ emergency()

◆ error()

◆ flush()

◆ getCapturedLog()

◆ info()

◆ isErrorMasked()

◆ log()

◆ maskErrors()

◆ notice()

◆ popErrorMask()

◆ setCaptureLog()

◆ setTrackId()

◆ stats()

◆ warning()

Field Documentation

◆ $capturedLog

◆ $captureLog

◆ $earlyLog

◆ $format

◆ $loggingHandler

◆ $logLevel

◆ $logLevelStack

◆ $logMask

◆ $shutdownRegistered

◆ $shuttingDown

◆ $trackid

◆ ALERT

◆ CRIT

◆ DEBUG

◆ EMERG

◆ ERR

◆ INFO

◆ NO_TRACKID

◆ NOTICE

◆ WARNING