[5.3] Improve System - Debug plugin code (#44844)

* Improve System - Debug plugin code

* Update plugins/system/debug/src/Extension/Debug.php

* On onAfterRespond is also accept ApplicationEvent

---------

Co-authored-by: Richard Fath <[email protected]>
Co-authored-by: Quy Ton <[email protected]>

Author: 3 people

plugins/system/debug/src/Extension/Debug.php

@@ -14,8 +14,12 @@
 use DebugBar\DebugBar;
 use DebugBar\OpenHandler;
 use Joomla\Application\ApplicationEvents;
+use Joomla\Application\Event\ApplicationEvent;
 use Joomla\CMS\Application\CMSApplicationInterface;
 use Joomla\CMS\Document\HtmlDocument;
+use Joomla\CMS\Event\Application\AfterRespondEvent;
+use Joomla\CMS\Event\Application\BeforeCompileHeadEvent;
+use Joomla\CMS\Event\Application\BeforeRespondEvent;
 use Joomla\CMS\Event\Plugin\AjaxEvent;
 use Joomla\CMS\Log\Log;
 use Joomla\CMS\Log\LogEntry;
@@ -172,14 +176,16 @@ public function __construct(DispatcherInterface $dispatcher, array $config, CMSA
         $this->setApplication($app);
         $this->setDatabase($db);
 
-        $this->debugLang = $this->getApplication()->get('debug_lang');
+        $app = $this->getApplication();
+
+        $this->debugLang = $app->get('debug_lang');
 
         // Skip the plugin if debug is off
-        if (!$this->debugLang && !$this->getApplication()->get('debug')) {
+        if (!$this->debugLang && !$app->get('debug')) {
             return;
         }
 
-        $this->getApplication()->set('gzip', false);
+        $app->set('gzip', false);
         ob_start();
         ob_implicit_flush(false);
 
@@ -195,19 +201,19 @@ public function __construct(DispatcherInterface $dispatcher, array $config, CMSA
 
         // Check whether we want to track the request history for future use.
         if ($this->params->get('track_request_history', false)) {
-            $storagePath = JPATH_CACHE . '/plg_system_debug_' . $this->getApplication()->getName();
+            $storagePath = JPATH_CACHE . '/plg_system_debug_' . $app->getName();
             $this->debugBar->setStorage(new FileStorage($storagePath));
         }
 
-        $this->debugBar->setHttpDriver(new JoomlaHttpDriver($this->getApplication()));
+        $this->debugBar->setHttpDriver(new JoomlaHttpDriver($app));
 
-        $this->isAjax = $this->getApplication()->getInput()->get('option') === 'com_ajax'
-            && $this->getApplication()->getInput()->get('plugin') === 'debug' && $this->getApplication()->getInput()->get('group') === 'system';
+        $this->isAjax = $app->getInput()->get('option') === 'com_ajax'
+            && $app->getInput()->get('plugin') === 'debug' && $app->getInput()->get('group') === 'system';
 
         $this->showLogs = (bool) $this->params->get('logs', true);
 
         // Log deprecated class aliases
-        if ($this->showLogs && $this->getApplication()->get('log_deprecated')) {
+        if ($this->showLogs && $app->get('log_deprecated')) {
             foreach (\JLoader::getDeprecatedAliases() as $deprecation) {
                 Log::add(
                     \sprintf(
@@ -226,11 +232,13 @@ public function __construct(DispatcherInterface $dispatcher, array $config, CMSA
     /**
      * Add an assets for debugger.
      *
+     * @param  BeforeCompileHeadEvent $event  The event instance.
+     *
      * @return  void
      *
      * @since   4.0.0
      */
-    public function onBeforeCompileHead()
+    public function onBeforeCompileHead(BeforeCompileHeadEvent $event): void
     {
         // Only if debugging or language debug is enabled.
         if ((JDEBUG || $this->debugLang) && $this->isAuthorisedDisplayDebug() && $this->getApplication()->getDocument() instanceof HtmlDocument) {
@@ -261,11 +269,13 @@ public function onBeforeCompileHead()
     /**
      * Show the debug info.
      *
+     * @param   AfterRespondEvent|ApplicationEvent  $event  The event instance.
+     *
      * @return  void
      *
      * @since   1.6
      */
-    public function onAfterRespond()
+    public function onAfterRespond(AfterRespondEvent|ApplicationEvent $event): void
     {
         $endTime    = microtime(true) - $this->timeInOnAfterDisconnect;
         $endMemory  = memory_get_peak_usage(false);
@@ -371,7 +381,7 @@ public function onAfterRespond()
     /**
      * AJAX handler
      *
-     * @param AjaxEvent $event
+     * @param  AjaxEvent $event  The event instance.
      *
      * @return  void
      *
@@ -413,22 +423,20 @@ private function isAuthorisedDisplayDebug(): bool
             return $result;
         }
 
+        $result = true;
+
         // If the user is not allowed to view the output then end here.
         $filterGroups = (array) $this->params->get('filter_groups', []);
 
         if (!empty($filterGroups)) {
-            $userGroups = $this->getApplication()->getIdentity()->get('groups');
+            $userGroups = $this->getApplication()->getIdentity()->groups;
 
             if (!array_intersect($filterGroups, $userGroups)) {
                 $result = false;
-
-                return false;
             }
         }
 
-        $result = true;
-
-        return true;
+        return $result;
     }
 
     /**
@@ -440,7 +448,7 @@ private function isAuthorisedDisplayDebug(): bool
      *
      * @since   4.0.0
      */
-    public function onAfterDisconnect(ConnectionEvent $event)
+    public function onAfterDisconnect(ConnectionEvent $event): void
     {
         if (!JDEBUG) {
             return;
@@ -657,11 +665,13 @@ private function collectLogs()
     /**
      * Add server timing headers when profile is activated.
      *
+     * @param   BeforeRespondEvent  $event  The event instance.
+     *
      * @return  void
      *
      * @since   4.1.0
      */
-    public function onBeforeRespond(): void
+    public function onBeforeRespond(BeforeRespondEvent $event): void
     {
         if (!JDEBUG || !$this->params->get('profile', 1)) {
             return;