dbxPerformanceTimer.class.php

Go to the documentation of this file.

<?php
 
dbx()->use_system_class('dbxDD');
 
class dbxPerformanceTimer {
 
   private const REQUEST_DD = 'dbx|dbxPerformanceRequest';
   private const TIMER_DD = 'dbx|dbxPerformanceTimer';
 
   private array $configFileCache = array();
 
   private function config_value(string $key, $default = '') {
      $value = dbx()->get_config('dbx', $key);
 
      if ($value !== 'undef') {
         return $value;
      }
 
      $cfg = $this->config_file_values();
      return $cfg[$key] ?? $default;
   }
 
   private function config_file_values(): array {
      if ($this->configFileCache) {
         return $this->configFileCache;
      }
 
      $file = dbx_os_path_file(dbx_get_base_dir() . 'dbx/modules/dbx/cfg/config.php');
      if (!is_file($file)) {
         return array();
      }
 
      $loader = static function ($file) {
         $config = array();
         include $file;
         return is_array($config) ? $config : array();
      };
 
      $this->configFileCache = $loader($file);
      return $this->configFileCache;
   }
 
   private function config_bool(string $key, $default = 0): bool {
      $value = $this->config_value($key, $default);
      return (int) $value === 1;
   }
 
   private function normalize_level($value): string {
      $level = strtolower(trim((string) $value));
      if ($level === 'details') {
         $level = 'detail';
      }
 
      return in_array($level, array('off', 'main', 'detail'), true) ? $level : '';
   }
 
   private function performance_level(): string {
      $level = $this->normalize_level($this->config_value('performance_timer_level', ''));
      if ($level !== '') {
         return $level;
      }
 
      $request = $this->config_bool('performance_timer_request', $this->config_value('performance_timer', 0));
      $db = $this->config_bool('performance_timer_db', $this->config_value('performance_timer_detail', 0));
 
      return ($request || $db) ? 'detail' : 'off';
   }
 
   private function is_enabled(): bool {
      return $this->performance_level() !== 'off';
   }
 
   private function is_db_section(string $section): bool {
      return $section === 'db-total'
         || $section === 'db-select'
         || $section === 'db-save'
         || substr($section, 0, 10) === 'db-select-'
         || substr($section, 0, 8) === 'db-save-';
   }
 
   private function is_main_section(string $section): bool {
      return in_array($section, array('system', 'js-total', 'db-total'), true);
   }
 
   private function sample_rate(): int {
      return max(1, (int) $this->config_value('performance_timer_sample_rate', 1));
   }
 
   private function should_sample(int $sampleRate): bool {
      if ($sampleRate <= 1) {
         return true;
      }
 
      try {
         return random_int(1, $sampleRate) === 1;
      } catch (\Throwable $e) {
         return mt_rand(1, $sampleRate) === 1;
      }
   }
 
   private function ensure_tables(): bool {
      try {
         $dd = dbx()->get_system_obj('dbxDD');
         return $dd->create_db_tab(self::REQUEST_DD) && $dd->create_db_tab(self::TIMER_DD);
      } catch (\Throwable $e) {
         return false;
      }
   }
 
   private function ms($seconds): int {
      return max(0, (int) round(((float) $seconds) * 1000));
   }
 
   private function kb($bytes): int {
      return (int) round(((float) $bytes) / 1024);
   }
 
   private function timer_ms(array $timer): int {
      if (isset($timer['time']) && is_numeric($timer['time']) && (float) $timer['time'] >= 0) {
         return $this->ms($timer['time']);
      }
 
      if (isset($timer['start_time'], $timer['end_time']) && is_numeric($timer['start_time']) && is_numeric($timer['end_time'])) {
         return $this->ms(max(0, (float) $timer['end_time'] - (float) $timer['start_time']));
      }
 
      return 0;
   }
 
   private function timer_memory_kb(array $timer): int {
      if (isset($timer['memory']) && is_numeric($timer['memory']) && (float) $timer['memory'] >= 0) {
         return $this->kb($timer['memory']);
      }
 
      if (isset($timer['start_memory'], $timer['end_memory']) && is_numeric($timer['start_memory']) && is_numeric($timer['end_memory'])) {
         return $this->kb(max(0, (float) $timer['end_memory'] - (float) $timer['start_memory']));
      }
 
      return 0;
   }
 
   private function timer_end_memory_mb(array $timer): int {
      if (isset($timer['end_memory']) && is_numeric($timer['end_memory']) && (float) $timer['end_memory'] >= 0) {
         return max(0, (int) ceil(((float) $timer['end_memory']) / 1048576));
      }
 
      if (isset($timer['start_memory']) && is_numeric($timer['start_memory']) && (float) $timer['start_memory'] >= 0) {
         return max(0, (int) ceil(((float) $timer['start_memory']) / 1048576));
      }
 
      return 0;
   }
 
   private function trim_text($value, int $length): string {
      $value = str_replace(array("\r", "\n", "\t"), ' ', (string) $value);
      return substr($value, 0, $length);
   }
 
   private function request_record(array $timers, int $sampleRate): array {
      $system = $timers['system'] ?? array();
      $uid = (int) dbx()->user();
      $modul = (string) dbx()->get_system_var('dbx_modul', dbx()->get_system_var('dbx_activ_modul', 'dbx'));
      $now = date('Y-m-d H:i:s');
 
      return array(
         'request_date'    => $now,
         'create_date'     => $now,
         'create_uid'      => $uid,
         'update_date'     => $now,
         'update_uid'      => $uid,
         'owner'           => $uid,
         'uid'             => $uid,
         'session_id'      => $this->trim_text(session_id(), 128),
         'modul'           => $this->trim_text($modul, 80),
         'run1'            => $this->trim_text(dbx()->get_system_var('dbx_run1', ''), 80),
         'run2'            => $this->trim_text(dbx()->get_system_var('dbx_run2', ''), 80),
         'ajax'            => (int) dbx()->get_system_var('dbx_ajax', 0, 'int'),
         'sync'            => (int) dbx()->get_request_var('dbx_sync', 1, 'int'),
         'method'          => $this->trim_text($_SERVER['REQUEST_METHOD'] ?? '', 12),
         'uri'             => $this->trim_text($_SERVER['REQUEST_URI'] ?? '', 1200),
         'total_time_ms'   => $this->timer_ms($system),
         'total_memory_kb' => $this->timer_memory_kb($system),
         'peak_memory_mb'  => $this->timer_end_memory_mb($system),
         'timer_count'     => count($timers),
         'sample_rate'     => $sampleRate,
      );
   }
 
   private function timer_record(int $requestId, string $requestDate, string $section, array $timer, int $sortOrder): array {
      $uid = (int) dbx()->user();
      $now = date('Y-m-d H:i:s');
 
      return array(
         'request_id'      => $requestId,
         'request_date'    => $requestDate,
         'create_date'     => $now,
         'create_uid'      => $uid,
         'update_date'     => $now,
         'update_uid'      => $uid,
         'owner'           => $uid,
         'sort_order'      => $sortOrder,
         'section'         => $this->trim_text($section, 80),
         'info'            => $this->trim_text($timer['info'] ?? '', 160),
         'time_ms'         => $this->timer_ms($timer),
         'memory_kb'       => $this->timer_memory_kb($timer),
         'start_memory_kb' => isset($timer['start_memory']) && is_numeric($timer['start_memory']) ? $this->kb($timer['start_memory']) : 0,
         'end_memory_kb'   => isset($timer['end_memory']) && is_numeric($timer['end_memory']) ? $this->kb($timer['end_memory']) : 0,
      );
   }
 
   private function cleanup_old_rows(): void {
      $days = (int) $this->config_value('performance_timer_keep_days', 14);
      if ($days <= 0) {
         return;
      }
 
      $cutoff = date('Y-m-d H:i:s', time() - ($days * 86400));
 
      try {
         $db = dbx()->get_system_obj('dbxDB');
         $db->delete(self::TIMER_DD, "request_date < '" . $cutoff . "'", 0, 0);
         $db->delete(self::REQUEST_DD, "request_date < '" . $cutoff . "'", 0, 0);
      } catch (\Throwable $e) {
         return;
      }
   }
 
   public function store(): int {
      if ((int) dbx()->get_system_var('dbx_ajax', 0, 'int') === 1) {
         return 0;
      }
 
      if ((int) dbx()->get_system_var('dbx_performance_timer_skip', 0, 'int') === 1) {
         return 0;
      }
 
      if ((int) dbx()->get_request_var('dbx_sync', 1, 'int') === 0) {
         return 0;
      }
 
      if (!$this->is_enabled()) {
         return 0;
      }
 
      $sampleRate = $this->sample_rate();
      if (!$this->should_sample($sampleRate)) {
         return 0;
      }
 
      global $dbx_run_timer;
      if (!isset($dbx_run_timer) || !is_array($dbx_run_timer) || !$dbx_run_timer) {
         return 0;
      }
 
      dbx()->set_system_var('dbx_performance_timer_store', 1);
      try {
         if (!$this->ensure_tables()) {
            return 0;
         }
 
         $performanceLevel = $this->performance_level();
         $detailEnabled = $performanceLevel === 'detail';
         $db = dbx()->get_system_obj('dbxDB');
         $request = $this->request_record($dbx_run_timer, $sampleRate);
         $requestId = 0;
 
         $requestId = ($db->insert(self::REQUEST_DD, $request, 0, 1, 1, 0) === 1) ? $db->get_insert_id() : 0;
 
         if ($requestId <= 0) {
            return 0;
         }
 
         $sort = 0;
         foreach ($dbx_run_timer as $section => $timer) {
            if (!is_array($timer)) {
               continue;
            }
 
            $section = (string) $section;
            if (!$detailEnabled && !$this->is_main_section($section)) {
               continue;
            }
 
            $db->insert(self::TIMER_DD, $this->timer_record($requestId, $request['request_date'], $section, $timer, $sort), 0, 1, 1, 0);
            $sort++;
         }
 
         $this->cleanup_old_rows();
         return $requestId;
      } catch (\Throwable $e) {
         return 0;
      } finally {
         dbx()->set_system_var('dbx_performance_timer_store', 0);
      }
   }
}