ilLoggerFactory Class Reference

Logging factory. More...

Collaboration diagram for ilLoggerFactory:

Public Member Functions
	isLoggingEnabled ()
	initUser (string $a_login)
	Init user specific log options. More...
	getSettings ()
	getComponentLogger (string $a_component_id)

Static Public Member Functions
static	getInstance ()
static	newInstance (ilLoggingSettings $settings)
static	getLogger (string $a_component_id)
	Get component logger. More...
static	getRootLogger ()
	The unique root logger has a fixed error level. More...

Protected Member Functions
	__construct (ilLoggingSettings $settings)
	isConsoleAvailable ()
	Check if console handler is available. More...
	getLoggers ()

Protected Attributes
const	DEFAULT_FORMAT = "[%suid%] [%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"
const	ROOT_LOGGER = 'root'
const	COMPONENT_ROOT = 'log_root'
const	SETUP_LOGGER = 'setup'
Container	$dic

Private Attributes
ilLoggingSettings	$settings
bool	$enabled = false
array	$loggers = array()

Static Private Attributes
static ilLoggerFactory	$instance = null

Detailed Description

Logging factory.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 37 of file class.ilLoggerFactory.php.

Constructor & Destructor Documentation

__construct()

ilLoggerFactory::__construct ( ilLoggingSettings  $settings )

protected

Definition at line 57 of file class.ilLoggerFactory.php.

    {
        global $DIC;
 
        $this->dic = $DIC;
        $this->settings = $settings;
        $this->enabled = $this->getSettings()->isEnabled();
    }

References $DIC, $settings, getSettings(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

getComponentLogger()

ilLoggerFactory::getComponentLogger

(

string

$a_component_id

)

Definition at line 170 of file class.ilLoggerFactory.php.

                                                              : ilLogger
    {
        if (isset($this->loggers[$a_component_id])) {
            return $this->loggers[$a_component_id];
        }
 
        $loggerNamePrefix = '';
        if (defined('CLIENT_ID')) {
            $loggerNamePrefix = CLIENT_ID . '_';
        }
 
        switch ($a_component_id) {
            case 'root':
                $logger = new Logger($loggerNamePrefix . 'root');
                break;
 
            default:
                $logger = new Logger($loggerNamePrefix . $a_component_id);
                break;
 
        }
 
        if (!$this->isLoggingEnabled()) {
            $null_handler = new NullHandler();
            $logger->pushHandler($null_handler);
 
            return $this->loggers[$a_component_id] = new ilComponentLogger($logger);
        }
 
 
        // standard stream handler
        $stream_handler = new StreamHandler(
            $this->getSettings()->getLogDir() . '/' . $this->getSettings()->getLogFile(),
            Logger::DEBUG, // default minimum level, will be overwritten by component log level
            true
        );
 
        if ($a_component_id == self::ROOT_LOGGER) {
            $stream_handler->setLevel($this->getSettings()->getLevelByComponent(self::COMPONENT_ROOT));
        } else {
            $stream_handler->setLevel($this->getSettings()->getLevelByComponent($a_component_id));
        }
 
        // format lines
        $line_formatter = new ilLineFormatter(static::DEFAULT_FORMAT, 'Y-m-d H:i:s.u', true, true);
        $stream_handler->setFormatter($line_formatter);
 
        if ($this->getSettings()->isCacheEnabled()) {
            // add new finger crossed handler
            $finger_crossed_handler = new FingersCrossedHandler(
                $stream_handler,
                new ErrorLevelActivationStrategy($this->getSettings()->getCacheLevel()),
                1000
            );
            $logger->pushHandler($finger_crossed_handler);
        } else {
            $logger->pushHandler($stream_handler);
        }
 
        if (
            $this->dic->offsetExists('ilUser') &&
            $this->dic->user() instanceof ilObjUser
        ) {
            if ($this->getSettings()->isBrowserLogEnabledForUser($this->dic->user()->getLogin())) {
                if ($this->isConsoleAvailable()) {
                    $browser_handler = new BrowserConsoleHandler();
                    $browser_handler->setLevel($this->getSettings()->getLevel());
                    $browser_handler->setFormatter($line_formatter);
                    $logger->pushHandler($browser_handler);
                }
            }
        }
 
 
        // suid log
        $logger->pushProcessor(function ($record) {
            $record['suid'] = substr(session_id(), 0, 5);
            return $record;
        });
 
        // append trace
        $logger->pushProcessor(new ilTraceProcessor(ilLogLevel::DEBUG));
 
 
        // register new logger
        $this->loggers[$a_component_id] = new ilComponentLogger($logger);
 
        return $this->loggers[$a_component_id];
    }

References CLIENT_ID, ilLogLevel\DEBUG, getSettings(), isConsoleAvailable(), and isLoggingEnabled().

Here is the call graph for this function:

getInstance()

static ilLoggerFactory::getInstance ( )

static

Definition at line 66 of file class.ilLoggerFactory.php.

                                        : ilLoggerFactory
    {
        if (!static::$instance instanceof ilLoggerFactory) {
            $settings = ilLoggingDBSettings::getInstance();
            static::$instance = new ilLoggerFactory($settings);
        }
        return static::$instance;
    }

References $settings, and ilLoggingDBSettings\getInstance().

Referenced by ilRbacAdmin\assignUser(), ilRbacAdmin\deassignUser(), getLogger(), getRootLogger(), ilCourseAppEventListener\handleUserAssignments(), ilInitialisation\initILIAS(), and ilInitialisation\initUserAccount().

Here is the call graph for this function:

Here is the caller graph for this function:

getLogger()

static ilLoggerFactory::getLogger ( string  $a_component_id )

static

Get component logger.

Definition at line 89 of file class.ilLoggerFactory.php.

                                                            : ilLogger
    {
        $factory = self::getInstance();
        return $factory->getComponentLogger($a_component_id);
    }

References $factory, and getInstance().

Referenced by ilObjUserFolderGUI\__construct(), ilObjWikiGUI\__construct(), ilObjGlossaryGUI\__construct(), ilNoteGUI\__construct(), ilObjLoggingSettingsGUI\__construct(), SurveyQuestionGUI\__construct(), ilExAssignment\__construct(), ilObjWorkspaceFolderGUI\__construct(), ilBookCronNotification\__construct(), ilXapiResultsCronjob\__construct(), ilGlossaryDataSet\__construct(), ilGlossaryTermPermission\__construct(), ilLearningModuleDataSet\__construct(), ilPDStudyProgrammeSimpleListGUI\__construct(), SurveyCategories\__construct(), ilObjSurveyQuestionPoolGUI\__construct(), ilCronFinishUnfinishedTestPasses\__construct(), ilWikiDataSet\__construct(), ilCheckSumOfWorkspaceFileSizesJob\__construct(), ilCollectWorkspaceFilesJob\__construct(), ilCopyWorkspaceFilesToTempDirectoryJob\__construct(), ilAccess\__construct(), ilRbacReview\__construct(), ILIAS\COPage\Editor\Components\Paragraph\ParagraphResponseFactory\__construct(), ilDataSet\__construct(), ilAppEventHandler\__construct(), ilImportMapping\__construct(), ilLTIAppEventListener\__construct(), ilLTIDataConnector\__construct(), ilLTIViewGUI\__construct(), ilMediaObjectDataSet\__construct(), ilStyleDataSet\__construct(), ILIAS\LearningModule\Export\LMHtmlExport\__construct(), ILIAS\Wiki\Export\WikiHtmlExport\__construct(), ILIAS\COPage\Editor\Server\Server\__construct(), ilRepoStandardUploadHandlerGUI\__construct(), ilExPeerReview\__construct(), ilMailAddressTypeFactory\__construct(), ilContainerXmlParser\__construct(), ilLTITool\__construct(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\__construct(), ilQuestionPageParser\__construct(), ilSurveyEvaluationGUI\__construct(), ilSurveyExecutionGUI\__construct(), ilSurveySkill\__construct(), ilSurveyPageEditGUI\__construct(), ilStartUpGUI\__construct(), ilWikiUserHTMLExport\__construct(), ilPageEditorGUI\__construct(), ilPageContent\__construct(), ilPageContentGUI\__construct(), ilObjectCopyGUI\__construct(), ilFSWebStorageExercise\__construct(), ilExAssignmentReminder\__construct(), ilGlossaryTermGUI\__construct(), ilObjCategory\__construct(), ilObjSCORM2004LearningModule\__construct(), ilObjSurvey\__construct(), ilObjFileGUI\__construct(), ilObjMediaPoolGUI\__construct(), ilPageObject\__construct(), ilUserStartingPointGUI\__construct(), ilMDBase\__construct(), ilLTIProviderObjectSettingGUI\__construct(), ilLTIProviderObjectSetting\__construct(), ilTree\__construct(), ilMail\__construct(), ilDownloadWorkspaceFolderBackgroundTask\__construct(), ilObjStudyProgramme\__construct(), ilObject\__construct(), ilMembershipCronNotificationsData\__construct(), ilUserRoleStartingPointTableGUI\__construct(), ilCOPageHTMLExport\__construct(), ilAdvancedMDRecordParser\__construct(), ilAdvancedMDParser\__construct(), ilPageObjectGUI\__construct(), ilRpcClient\__construct(), ilCategoryXmlParser\__construct(), SurveyQuestion\__construct(), ilMassMailTaskProcessor\__construct(), ilPCParagraph\_input2xml(), ilTree\_removeEntry(), ilObjSCORMTracking\_syncReadEvent(), ilObject\applyDidacticTemplate(), ilCourseMembershipGUI\assignMembers(), ilGroupMembershipGUI\assignMembers(), ilLearningSequenceMembershipGUI\assignMembers(), ilCronStartUp\authenticate(), ilWebDAVAuthentication\authenticate(), ilInitialisation\blockedAuthentication(), ilStudyProgrammeDIC\buildDIC(), ilCmiXapiStatementsReportLinkBuilder\buildPipeline(), ilAuthProviderSaml\buildUserAttributeXml(), ilvCard\buildVCard(), ilSoapUtils\callNextDependency(), ilSoapUtils\callNextNode(), ilAuthFrontend\checkIp(), ilSoapUtils\cloneDependencies(), ilCourseObjectiveQuestion\cloneDependencies(), ilSoapUtils\cloneNode(), ILIAS\Awareness\User\Collector\collectUsers(), ilLORandomTestQuestionPools\copy(), ilQuestionPageParser\copyMobFiles(), ilObjectCopyGUI\copyMultipleNonContainer(), ilContainer\create(), ilObjSAHSLearningModule\delete(), ilSCORMItem\delete(), ilObjRole\delete(), ilPageObject\delete(), ilObjMediaObject\delete(), ilAccountRegistrationGUI\distributeMails(), ilLDAPServer\doConnectionCheck(), ilStartUpGUI\doLTIAuthentication(), ilStartUpGUI\doSamlAuthentication(), ilStartUpGUI\doStandardAuthentication(), ilUserProfileStartUpStep\execute(), ilObjSAHSLearningModuleGUI\executeCommand(), ilSCORMPresentationGUI\executeCommand(), ilSAHSEditGUI\executeCommand(), ilRepositoryGUI\executeCommand(), ilSCORMPresentationGUI\explorer(), ilObjCmiXapiGUI\fetchXapiStatements(), ilChatroomServerConnector\file_get_contents(), ilLuceneSearchResultFilter\filter(), ilLTIPlatform\fromConsumerKey(), ilLTIPlatform\fromRecordId(), SeqTreeBuilder\getADLSEQObjectives(), ilSkillUsage\getAllUsagesOfTemplate(), ilSCORM13PlayerGUI\getDebugValues(), ilObjSCORMInitData\getIliasScormVars(), ILIAS\Awareness\User\ProviderCurrentCourse\getInitialUserSet(), ilObjLTIConsumer\getLogger(), ilSCORM13PlayerGUI\getNodeData(), SeqTreeBuilder\getObjectives(), ilObjectPlugin\getPluginObjectByType(), ilObjSurvey\getSurveysWithTutorResults(), ilInitialisation\goToLogin(), ilInitialisation\handleAuthenticationFail(), ilAuthFrontend\handleAuthenticationSuccess(), ilCourseReferenceAppEventListener\handleEvent(), ilLTIAppEventListener\handleEvent(), ilLTIAppEventListener\handleOutcomeWithoutLP(), ilWebLinkXmlParser\handlerEndTag(), ilAuthProviderSaml\handleSamlAuth(), ilLuceneSearcher\highlight(), ilSCORM13Package\il_import(), ilSoapUtils\ilClone(), ilSoapUtils\ilCloneDependencies(), ilAuthProviderSaml\importUser(), ilLearningModuleImporter\init(), ilSurveyImporter\init(), ilWikiExporter\init(), ilContainerImporter\init(), ilObjectCopyGUI\init(), ilStyleImporter\init(), ilObjectRolePermissionTableGUI\initColumns(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilAuthFrontendCredentialsLTI\initFromRequest(), ilNestedSetTree\insertNode(), ilAuthProviderLTI\isAuthModeLTI(), ilSoapUtils\linkNode(), ilSoapUserAdministration\login(), ilLTIDataConnector\lookupResourcesForAllUsersSinceDate(), ilMDRights\lookupRightsByTypeAndCopyright(), ilNestedSetTree\moveTree(), ilLuceneHighlighterResultParser\parse(), ilRepositoryObjectDetailSearch\performLuceneSearch(), ilObjectSearch\performSearch(), ilLuceneSearcher\performSearch(), ilSCORM13PlayerGUI\postLogEntry(), SurveyQuestion\QTIMaterialToString(), ilObjLTIAdministration\readReleaseObjects(), ilInitialisation\redirectToStartingPage(), ilSCORM13Package\removeCPData(), ilInitialisation\resumeUserSession(), ilExcCronReminders\run(), ilSurveyCronNotification\run(), ilCleanCOPageHistoryCronjob\run(), ilMailCronOrphanedMails\run(), ilLuceneIndexer\run(), ilSkillNotifications\run(), ilMailCronOrphanedMails\saveCustomSettings(), ilMultilingualismGUI\saveLanguages(), ilPermissionGUI\savePermissions(), ilMailLuceneSearcher\search(), ilLPTableBaseGUI\searchObjects(), ilMailMimeTransportBase\send(), ilMailMimeTransportNull\send(), ilMailNotification\sendMail(), ilRbacAdmin\setBlockedStatus(), ilFileXMLParser\setFileContents(), ilSCORM2004StoreData\setGlobalObjectives(), ilUserProfileStartUpStep\shouldInterceptRequest(), ilMailFormGUI\showForm(), ilStudyProgrammeDIC\specificDicFor(), ilSearchAppEventListener\storeElement(), ilObjSCORMTracking\storeJsApiCmi(), ilPasswordAssistanceGUI\submitAssistanceForm(), ilPasswordAssistanceGUI\submitUsernameAssistanceForm(), ilLDAPUserSynchronisation\sync(), ilObjSCORMTracking\syncGlobalStatus(), ilAuthFrontendCredentialsSoap\tryAuthenticationOnLoginPage(), ilPermissionGUI\unblockRoles(), ilObjCourseReference\update(), ilContainer\update(), ilLuceneIndexer\updateLuceneIndex(), ilObjGroupGUI\updateObject(), ilExAssignment\uploadAssignmentFiles(), ilObjSAHSLearningModuleGUI\uploadObject(), ilLuceneSearchResult\valid(), ilScormAiccDataSet\writeData(), and ilSCORM2004StoreData\writeGObjective().

Here is the call graph for this function:

Here is the caller graph for this function:

getLoggers()

ilLoggerFactory::getLoggers ( )

protected

Returns

ilComponentLogger[]

Definition at line 165 of file class.ilLoggerFactory.php.

                                   : array
    {
        return $this->loggers;
    }

References $loggers.

getRootLogger()

static ilLoggerFactory::getRootLogger ( )

static

The unique root logger has a fixed error level.

Definition at line 98 of file class.ilLoggerFactory.php.

                                          : ilLogger
    {
        $factory = self::getInstance();
        return $factory->getComponentLogger(self::ROOT_LOGGER);
    }

References $factory, and getInstance().

Referenced by ilAssFileUploadUploadsExporter\createFileUploadCollectionZipFile(), ilInitialisation\initLog(), and assFlashQuestion\saveAdditionalQuestionDataToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

getSettings()

ilLoggerFactory::getSettings

(

)

Definition at line 157 of file class.ilLoggerFactory.php.

                                 : ilLoggingSettings
    {
        return $this->settings;
    }

References $settings.

Referenced by __construct(), getComponentLogger(), and initUser().

Here is the caller graph for this function:

initUser()

ilLoggerFactory::initUser

(

string

$a_login

)

Init user specific log options.

Definition at line 108 of file class.ilLoggerFactory.php.

                                             : void
    {
        if (!$this->getSettings()->isBrowserLogEnabledForUser($a_login)) {
            return;
        }
 
        foreach ($this->loggers as $a_component_id => $logger) {
            if ($this->isConsoleAvailable()) {
                $browser_handler = new BrowserConsoleHandler();
                $browser_handler->setLevel($this->getSettings()->getLevelByComponent($a_component_id));
                $browser_handler->setFormatter(new ilLineFormatter(static::DEFAULT_FORMAT, 'Y-m-d H:i:s.u', true, true));
                $logger->getLogger()->pushHandler($browser_handler);
            }
        }
    }

References getSettings(), and isConsoleAvailable().

Here is the call graph for this function:

isConsoleAvailable()

ilLoggerFactory::isConsoleAvailable ( )

protected

Check if console handler is available.

Definition at line 127 of file class.ilLoggerFactory.php.

                                           : bool
    {
        if (ilContext::getType() != ilContext::CONTEXT_WEB) {
            return false;
        }
        if (
            $this->dic->isDependencyAvailable('ctrl') && $this->dic->ctrl()->isAsynch() ||
            (
                $this->dic->isDependencyAvailable('http') &&
                strtolower($this->dic->http()->request()->getServerParams()['HTTP_X_REQUESTED_WITH'] ?? '') === 'xmlhttprequest'
            )
        ) {
            return false;
        }
 
        if (
            $this->dic->isDependencyAvailable('http') &&
            strpos($this->dic->http()->request()->getServerParams()['HTTP_ACCEPT'], 'text/html') !== false
        ) {
            return true;
        }
        if (
            $this->dic->isDependencyAvailable('http') &&
            strpos($this->dic->http()->request()->getServerParams()['HTTP_ACCEPT'], 'application/json') !== false
        ) {
            return false;
        }
        return true;
    }

References ilContext\CONTEXT_WEB, and ilContext\getType().

Referenced by getComponentLogger(), and initUser().

Here is the call graph for this function:

Here is the caller graph for this function:

isLoggingEnabled()

ilLoggerFactory::isLoggingEnabled

(

)

Definition at line 80 of file class.ilLoggerFactory.php.

                                      : bool
    {
        return $this->enabled;
    }

References $enabled.

Referenced by getComponentLogger().

Here is the caller graph for this function:

newInstance()

static ilLoggerFactory::newInstance ( ilLoggingSettings  $settings )

static

Definition at line 75 of file class.ilLoggerFactory.php.

                                                                   : ilLoggerFactory
    {
        return static::$instance = new self($settings);
    }

References $settings.

Field Documentation

$dic

Container ilLoggerFactory::$dic

protected

Definition at line 48 of file class.ilLoggerFactory.php.

$enabled

bool ilLoggerFactory::$enabled = false

private

Definition at line 50 of file class.ilLoggerFactory.php.

Referenced by isLoggingEnabled().

$instance

ilLoggerFactory ilLoggerFactory::$instance = null

staticprivate

Definition at line 45 of file class.ilLoggerFactory.php.

$loggers

array ilLoggerFactory::$loggers = array()

private

Definition at line 55 of file class.ilLoggerFactory.php.

Referenced by getLoggers().

$settings

ilLoggingSettings ilLoggerFactory::$settings

private

Definition at line 47 of file class.ilLoggerFactory.php.

Referenced by __construct(), getInstance(), getSettings(), and newInstance().

COMPONENT_ROOT

const ilLoggerFactory::COMPONENT_ROOT = 'log_root'

protected

Definition at line 42 of file class.ilLoggerFactory.php.

DEFAULT_FORMAT

const ilLoggerFactory::DEFAULT_FORMAT = "[%suid%] [%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"

protected

Definition at line 39 of file class.ilLoggerFactory.php.

ROOT_LOGGER

const ilLoggerFactory::ROOT_LOGGER = 'root'

protected

Definition at line 41 of file class.ilLoggerFactory.php.

SETUP_LOGGER

const ilLoggerFactory::SETUP_LOGGER = 'setup'

protected

Definition at line 43 of file class.ilLoggerFactory.php.

---

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

• Services/Logging/classes/public/class.ilLoggerFactory.php