Civi/API/Subscriber/DebugSubscriber.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 namespace Civi\API\Subscriber;
  13
  14 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15
  16 /**
  17  * Class XDebugSubscriber
  18  * @package Civi\API\Subscriber
  19  */
  20 class DebugSubscriber implements EventSubscriberInterface {
  21
  22   /**
  23    * @var \Civi\API\LogObserver
  24    */
  25   private $debugLog;
  26
  27   /**
  28    * @var bool
  29    */
  30   private $enableStats;
  31
  32   public function __construct() {
  33     $version = phpversion('xdebug');
  34     switch ($version ? substr($version, 0, 2) : NULL) {
  35       case '2.':
  36         $this->enableStats = function_exists('xdebug_time_index');
  37         break;
  38
  39       case '3.':
  40         $xdebugMode = explode(',', ini_get('xdebug.mode'));
  41         $this->enableStats = in_array('develop', $xdebugMode);
  42         break;
  43
  44       default:
  45         $this->enableStats = FALSE;
  46         break;
  47     }
  48   }
  49
  50   /**
  51    * @return array
  52    */
  53   public static function getSubscribedEvents() {
  54     return [
  55       'civi.api.prepare' => ['onApiPrepare', 999],
  56       'civi.api.respond' => ['onApiRespond', -999],
  57     ];
  58   }
  59
  60   public function onApiPrepare(\Civi\API\Event\PrepareEvent $event) {
  61     $apiRequest = $event->getApiRequest();
  62     if (!isset($this->debugLog)
  63       && !empty($apiRequest['params']['debug'])
  64       && (empty($apiRequest['params']['check_permissions']) || \CRM_Core_Permission::check('view debug output'))
  65     ) {
  66       $this->debugLog = new \Civi\API\LogObserver();
  67       \CRM_Core_Error::createDebugLogger()->attach($this->debugLog);
  68     }
  69   }
  70
  71   /**
  72    * @param \Civi\API\Event\RespondEvent $event
  73    *   API response event.
  74    */
  75   public function onApiRespond(\Civi\API\Event\RespondEvent $event) {
  76     $apiRequest = $event->getApiRequest();
  77     $result = $event->getResponse();
  78     if (!empty($apiRequest['params']['debug'])
  79       && (empty($apiRequest['params']['check_permissions']) || \CRM_Core_Permission::check('view debug output'))
  80     ) {
  81       if (is_a($result, '\Civi\Api4\Generic\Result')) {
  82         $result->debug = $result->debug ?? [];
  83         $debug =& $result->debug;
  84       }
  85       // result would not be an array for api3 getvalue
  86       elseif (is_array($result)) {
  87         $result['xdebug'] = $result['xdebug'] ?? [];
  88         $debug =& $result['xdebug'];
  89       }
  90       else {
  91         return;
  92       }
  93       if (isset($this->debugLog) && $this->debugLog->getMessages()) {
  94         $debug['log'] = $this->debugLog->getMessages();
  95       }
  96       if ($this->enableStats) {
  97         $debug['peakMemory'] = xdebug_peak_memory_usage();
  98         $debug['memory'] = xdebug_memory_usage();
  99         $debug['timeIndex'] = xdebug_time_index();
 100       }
 101       $event->setResponse($result);
 102     }
 103   }
 104
 105 }