supernova-ws / SuperNova

classes/debug.php

<?php /** @noinspection PhpUnnecessaryCurlyVarSyntaxInspection */

/*
 * debug.php ::  Clase Debug, maneja reporte de eventos
 *
 * V4.0 copyright 2010-2011 by Gorlum for http://supernova.ws
 *  [!] Merged `errors` to `logs`
 *  [+] Now debugger can work with database detached. All messages would be dumped to page
 *  [+] Now `logs` has both human-readable and machine-readable fields
 *
 * V3.0 copyright 2010 by Gorlum for http://supernova.ws
 *  [+] Full rewrtie & optimize
 *  [*] Now there is fallback procedure if no link to db detected
 *
 * V2.0 copyright 2010 by Gorlum for http://supernova.ws
 *  [*] Now error also contains backtrace - to see exact way problem comes
 *  [*] New method 'warning' sends message to dedicated SQL-table for non-errors
 *
 * V1.0 Created by Perberos. All rights reversed (C) 2006
 *
 *  Experiment code!!!
 *
 * vamos a experimentar >:)
 * le veo futuro a las classes, ayudaria mucho a tener un codigo mas ordenado...
 * que esperabas!!! soy newbie!!! D':<
*/

use DBAL\db_mysql;

if (!defined('INSIDE')) {
  die("attemp hacking");
}

class debug {
  protected $log;
  protected $numqueries;
  protected $log_array;

  public function log_file($message, $ident_change = 0) {
    if (!defined('SN_DEBUG_LOG') || !SN_DEBUG_LOG) {
      return;
    }

    static $ident = 0;
    static $logFileName;

    if (!$logFileName) {
      $logFileName = SN_ROOT_PHYSICAL . '/.logs/supernova.log';
      file_put_contents($logFileName, "\r\n\r\n", FILE_APPEND);
    }
    if ($ident_change < 0) {
      $ident += $ident_change * 2;
    }
    file_put_contents($logFileName, date(FMT_DATE_TIME_SQL, time()) . str_repeat(' ', $ident + 1) . $message . "\r\n", FILE_APPEND);
    if ($ident_change > 0) {
      $ident += $ident_change * 2;
    }
  }

  public function log_sql($message, $ident_change = 0) {
    static $ident = 0;
    static $logFileName;
    static $mt_rand;

    if (!$mt_rand) {
      $mt_rand = mt_rand();
    }

    if (!$logFileName) {
      $dbName      = SN::$db->dbName;
      $logFileName = SN_ROOT_PHYSICAL . "/.logs/{$dbName}.mysql." . date('Y-m-d-H-i-s.') . sprintf("%06d", gettimeofday()["usec"]) . ".log";
    }
    if ($ident_change < 0) {
      $ident += $ident_change * 2;
    }
    file_put_contents($logFileName, str_repeat(' ', $ident) . $message . "\n\n", FILE_APPEND);
    if ($ident_change > 0) {
      $ident += $ident_change * 2;
    }
  }

  public function __construct() {
    $this->log        = '';
    $this->numqueries = 0;
  }

  function add($mes) {
    $this->log .= $mes;
    $this->numqueries++;
  }

  function add_to_array($mes) {
    $this->log_array[] = $mes;
  }

  function echo_log() {
    echo '<br><table><tr><td class=k colspan=4><a href="' . SN_ROOT_PHYSICAL . "admin/settings.php\">Debug Log</a>:</td></tr>{$this->log}</table>";
    die();

Using exit here is not recommended.

  }

  public function compact_backtrace($backtrace, $long_comment = false, $onlyLastX = null) {
    static $exclude_functions = array(
      // Caller not needed
      'comment_query',
      // Excluding includes/requires
      'include', 'include_once', 'require_once', 'require',
      // Excluding query calls/DB wrap functions
      'doquery',
      'db_get_record_list', // 'db_user_by_id', 'db_get_user_by_id',
      'doSelect', 'doSelectFetch',
      'db_query_update',
      'selectValue',
      // classPersistent
      '__get', 'db_loadItem', '__set', 'db_saveItem',
      // Constructors ?! Why not...
      '__construct',
      // Hook handlers
      'sn_function_call',
      // Chat
      'db_chat_player_list_online',
      // Transaction-related functions
      'db_transaction_commit', 'transactionCommit', 'transactionStart', 'db_transaction_start', 'db_transaction_rollback', 'transactionRollback',
    );

    $raw      = [];
    $filtered = [];
    foreach ($backtrace as $a_trace) {
      $function =
        (!empty($a_trace['type'])
          ? ($a_trace['type'] == '->'
            ? "({$a_trace['class']})" . get_class($a_trace['object'])
            : $a_trace['class']
          ) . $a_trace['type']
          : ''
        ) . $a_trace['function'] . '()';

      $file = str_replace(SN_ROOT_PHYSICAL, '', str_replace('\\', '/', !empty($a_trace['file']) ? $a_trace['file'] : ''));

      $line  = !empty($a_trace['line']) ? '@' . $a_trace['line'] : '';
      $raw[] = "{$function} - '{$file}'{$line}";

      if (!in_array($a_trace['function'], $exclude_functions)) {
        $filtered[] = &$raw[count($raw) - 1];
      }

      if (!$long_comment) {
        break;
      }
    }

    $raw      = array_reverse($raw);
    $filtered = array_reverse($filtered);

    if ($onlyLastX) {
      $raw      = array_slice($raw, -$onlyLastX);
      $filtered = array_slice($filtered, -$onlyLastX);
    }

    return [$raw, $filtered,];
  }

  /**
   * @param array  $backtrace
   * @param string $sql
   *
   * @return string
   */
  public function comment_query($backtrace, $sql) {
    list($raw, $filtered,) = $this->compact_backtrace($backtrace, defined('DEBUG_SQL_COMMENT_LONG'));

    $sql_commented = [
      "/* ",
      'date' => date("s.") . sprintf("%06d", gettimeofday()["usec"]),
      !empty($filtered) ? "\n" . implode("\n", $filtered) . " \n" : '',
      "*/\n",
      // SQL itself with removed double spaces
      preg_replace("/\s+/", ' ', $sql),
    ];

    if (defined('DEBUG_SQL_FILE_LOG') && !empty(DEBUG_SQL_FILE_LOG)) {
      $this->log_sql(implode('', $sql_commented));
    }

//      $sql_commented = '/* ' . implode("<br />", $sql_comment) . '<br /> */ ' . preg_replace("/\s+/", ' ', $sql);
//      $isSelect = strpos(strtoupper($query), 'SELECT') !== false ? 'true' : 'false';
    $sql_commented['date'] = date('Y-m-d H:i:') . $sql_commented['date'];

//      if(strpos($sql_comment, 'compact_backtrace') === false) {
//        $transaction_id = SN::db_transaction_check(false) ? SN::$transaction_id : SN::$transaction_id++;
//        $result[] = "tID {$transaction_id}";
//      }

    if (defined('DEBUG_SQL_ERROR')) {
      array_unshift($raw, preg_replace("/\s+/", ' ', $sql));
      array_unshift($raw, $sql_commented['date']);
      $this->add_to_array($raw);
    }

    $sql = implode('', $sql_commented);

    return $sql;
  }


  function dump($dump = false, $force_base = false, $deadlock = false) {
    if ($dump === false) {
      return [];
    }

    $error_backtrace = array();
    $base_dump       = false;

    if ($force_base === true) {
      $base_dump = true;
    }

    if ($dump === true) {
      $base_dump = true;
    } else {
      if (!is_array($dump)) {
        $dump = array('var' => $dump);
      }

      foreach ($dump as $dump_var_name => $dump_var) {
        if ($dump_var_name == 'base_dump') {
          $base_dump = $dump_var;
        } else {
          $error_backtrace[$dump_var_name] = $dump_var;
        }
      }
    }

    if ($deadlock && ($q = SN::$db->mysql_get_innodb_status())) {
      $error_backtrace['deadlock'] = explode("\n", $q['Status']);
      foreach ($error_backtrace['cSN_data'] as &$location) {
        foreach ($location as $location_id => &$location_data) //          $location_data = $location_id;
        {
          $location_data = isset($location_data['username']) ? $location_data['username'] :
            (isset($location_data['name']) ? $location_data['name'] : $location_id);
        }
      }
    }

    if ($base_dump) {
      if (!is_array($this->log_array) || empty($this->log_array)) {
        $this->log_array = [];
      } else {
        foreach ($this->log_array as $log) {
          $error_backtrace['queries'][] = $log;
        }
      }

      $error_backtrace['backtrace'] = debug_backtrace();
      unset($error_backtrace['backtrace'][1]);
      unset($error_backtrace['backtrace'][0]);

      // Converting object instances to object names

      foreach ($error_backtrace['backtrace'] as &$backtrace) {
        if (!empty($backtrace['object']) && is_object($backtrace['object'])) {
          $backtrace['object'] = get_class($backtrace['object']);
        }

        if (empty($backtrace['args'])) {
          continue;
        }

        // Doing same conversion for backtrace params
        foreach ($backtrace['args'] as &$arg) {
          if (is_object($arg)) {
            $arg = 'object::' . get_class($arg);
          }
        }
      }

      // $error_backtrace['query_log'] = "\r\n\r\nQuery log\r\n<table><tr><th>Number</th><th>Query</th><th>Page</th><th>Table</th><th>Rows</th></tr>{$this->log}</table>\r\n";
      $error_backtrace['$_GET']     = $_GET;
      $error_backtrace['$_POST']    = $_POST;
      $error_backtrace['$_REQUEST'] = $_REQUEST;
      $error_backtrace['$_COOKIE']  = $_COOKIE;
      $error_backtrace['$_SESSION'] = empty($_SESSION) ? [] : $_SESSION;
      $error_backtrace['$_SERVER']  = $_SERVER;
      global $user, $planetrow;
      $error_backtrace['user']      = $user;
      $error_backtrace['planetrow'] = $planetrow;
    }

    return $error_backtrace;
  }

  function error_fatal($die_message, $details = 'There is a fatal error on page') {
    // TODO - Записывать детали ошибки в лог-файл
    die($die_message);
  }

  public function error($message = 'There is a error on page', $title = 'Internal Error', $httpCode = 500, $dump = true) {
    global $config, $sys_stop_log_hit, $lang, $sys_log_disabled, $user;

    if (empty(SN::$db->connected)) {
      // TODO - писать ошибку в файл
      die('SQL server currently unavailable. Please contact Administration...');
    }

    db_mysql::db_transaction_rollback();

    if (SN::$config->debug == 1) {
      /** @noinspection HtmlDeprecatedTag */
      /** @noinspection XmlDeprecatedElement */
      /** @noinspection HtmlDeprecatedAttribute */
      echo "<h2>{$title}</h2><br><font color=red>" . htmlspecialchars($message) . "</font><br><hr>";
      echo "<table>{$this->log}</table>";
    }

    $fatal_error = 'Fatal error: cannot write to `logs` table. Please contact Administration...';

    $error_text      = SN::$db->db_escape($message);
    $error_backtrace = $this->dump($dump, true, strpos($message, 'Deadlock') !== false);

    if (!$sys_log_disabled) {
      $this->_writeLogMessage($httpCode, $user, $title, $message, $error_backtrace, $fatal_error);

      $message = "Пожалуйста, свяжитесь с админом, если ошибка повторится. Ошибка №: <b>" . SN::$db->db_insert_id() . "</b>";

      $sys_stop_log_hit = true;
      $sys_log_disabled = true;
      !function_exists('messageBox') ? die($message) : SnTemplate::messageBox($message, 'Ошибка', '', 0, false);
    } else {
//        // TODO Здесь надо писать в файло
      ob_start();
      print("<hr>User ID {$user['id']} raised error code {$httpCode} titled '{$title}' with text '{$error_text}' on page {$_SERVER['SCRIPT_NAME']}");

      foreach ($error_backtrace as $name => $value) {
        print('<hr>');
        pdump($value, $name);
      }
      ob_end_flush();
      die();
    }
  }

  function warning($message, $title = 'System Message', $httpCode = 300, $dump = false) {
    global $user, $lang, $sys_log_disabled;

    if (empty(SN::$db->connected)) {
      // TODO - писать ошибку в файл
      die('SQL server currently unavailable. Please contact Administration...');
    }

    $fatal_error = 'Fatal error: cannot write to `logs` table. Please contact Administration...';

    $error_backtrace = $this->dump($dump, false);

    if (empty($sys_log_disabled)) {
      $this->_writeLogMessage($httpCode, $user, $title, $message, $error_backtrace, $fatal_error);
    } else {
//        // TODO Здесь надо писать в файло
      $id = !empty($user['id']) ? $user['id'] : 0;
      print("<hr>User ID {$id} made log entry with code {$httpCode} titled '{$title}' with text '{$message}' on page {$_SERVER['SCRIPT_NAME']}");
    }
  }

  /**
   * @param       $httpCode
   * @param       $user
   * @param       $title
   * @param       $message
   * @param array $error_backtrace
   * @param       $fatal_error
   *
   * @return void
   */
  function _writeLogMessage($httpCode, $user, $title, $message, array $error_backtrace, $fatal_error) {
    /** @noinspection SqlResolve */
    $query = "INSERT INTO `{{logs}}` SET
        `log_time` = '" . time() . "', `log_code` = '" . SN::$db->db_escape($httpCode) . "', " .
      "`log_sender` = '" . (!empty($user['id']) ? SN::$db->db_escape($user['id']) : 0) . "', " .
      "`log_username` = '" . SN::$db->db_escape(!empty($user['user_name']) ? $user['user_name'] : '') . "', " .
      "`log_title` = '" . SN::$db->db_escape($title) . "',  `log_text` = '" . SN::$db->db_escape($message) . "', " .
      "`log_page` = '" . SN::$db->db_escape(strpos($_SERVER['SCRIPT_NAME'], SN_ROOT_RELATIVE) === false ? $_SERVER['SCRIPT_NAME'] : substr($_SERVER['SCRIPT_NAME'], strlen(SN_ROOT_RELATIVE))) . "'" . ", " .
      "`log_dump` = '" . ($error_backtrace ? SN::$db->db_escape(json_encode($error_backtrace)) : '') . "'" . ";";

    doquery($query, '', false, true) or die($fatal_error . SN::$db->db_error());
  }
}

// Copyright (c) 2009-2010 Gorlum for http://supernova.ws
// Dump variables nicer then var_dump()

function dump($value, $varname = null, $level = 0, $dumper = '') {
  if (isset($varname)) {
    $varname .= " = ";
  }

  if ($level == -1) {
    $trans[' ']  = '&there4;';
    $trans["\t"] = '&rArr;';
    $trans["\n"] = '&para;;';
    $trans["\r"] = '&lArr;';
    $trans["\0"] = '&oplus;';

    return strtr(htmlspecialchars($value), $trans);
  }
  if ($level == 0) {
//    $dumper = '<pre>' . mt_rand(10, 99) . '|' . $varname;
    $dumper = mt_rand(10, 99) . '|' . $varname;
  }

  $type   = gettype($value);
  $dumper .= $type;

  if ($type == 'string') {
    $dumper .= '(' . strlen($value) . ')';
    $value  = dump($value, '', -1);
  } elseif ($type == 'boolean') {
    $value = ($value ? 'true' : 'false');
  } elseif ($type == 'object') {
    $props  = get_class_vars(get_class($value));
    $dumper .= '(' . count($props) . ') <u>' . get_class($value) . '</u>';
    foreach ($props as $key => $val) {
      $dumper .= "\n" . str_repeat("\t", $level + 1) . $key . ' => ';
      $dumper .= dump($value->$key, '', $level + 1);
    }
    $value = '';
  } elseif ($type == 'array') {
    $dumper .= '(' . count($value) . ')';
    foreach ($value as $key => $val) {
      $dumper .= "\n" . str_repeat("\t", $level + 1) . dump($key, '', -1) . ' => ';
      $dumper .= dump($val, '', $level + 1);
    }
    $value = '';
  }
  $dumper .= " <b>$value</b>";
//  if($level == 0) {
//    $dumper .= '</pre>';
//  }

  return $dumper;
}

function pdump($value, $varname = null) {
  $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
//  print_rr($backtrace);
//  $backtrace = $backtrace[1];

  $caller = '';
  if (defined('SN_DEBUG_PDUMP_CALLER') && SN_DEBUG_PDUMP_CALLER) {
    $caller = (!empty($backtrace[1]['class']) ? $backtrace[1]['class'] : '') .
      (!empty($backtrace[1]['type']) ? $backtrace[1]['type'] : '') .
      $backtrace[1]['function'] .
      (!empty($backtrace[0]['file'])
        ? (
          ' (' . substr($backtrace[0]['file'], SN_ROOT_PHYSICAL_STR_LEN) .
          (!empty($backtrace[0]['line']) ? ':' . $backtrace[0]['line'] : '') .
          ')'
        )
        : ''
      );
    $caller = "\r\n" . $caller;
  }

  if (php_sapi_name() == "cli") {
    print("\n" .
      dump($value, $varname) .
      $caller .
      "\n\n"
    );
  } else {
    print('<pre style="text-align: left; background-color: #111111; color: #0A0; font-family: Courier, monospace !important; padding: 1em 0; font-weight: 800; font-size: 14px;">' .
      dump($value, $varname) .
      $caller .
      '</pre>'
    );
  }
}

function debug($value, $varname = null) {
  pdump($value, $varname);
}

function pr($prePrint = false) {
  if ($prePrint) {
    print("<br>");
  }
  print(mt_rand() . "<br>");
}

function pc($prePrint = false) {
  global $_PRINT_COUNT_VALUE;
  $_PRINT_COUNT_VALUE++;

  if ($prePrint) {
    print("<br>");
  }
  print($_PRINT_COUNT_VALUE . "<br>");
}

function prep($message) {
  print('<pre>' . $message . '</pre>');
}

function backtrace_no_arg() {
  $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
  array_shift($trace);

  return $trace;
}

if (!function_exists('pre')) {
  define('START', microtime(true)); // SHOULD NEVER BE REMOVED!

  /**
   * @param mixed $value     <p>
   *                         The variable you want to export.
   *                         </p>
   * @param mixed ...$values [optional]
   *
   * @return void
   */
  function pre() {
    if (func_num_args() <= 0) {
      return;
    }

    foreach (func_get_args() ?: [] as $var) {
      print "<pre>";
      print_r(
        $var === null ? 'null' :
          (($type = gettype($var)) == 'object' || $type == 'array'
            ? $var :
            ($type === 'string'
              ? $type . '(' . strlen($var) . ') `' . $var . '`' :
              ($type == 'boolean'
                ? ($var ? 'true' : 'false')
                : $type . ' ' . print_r($var, true)
              )
            )
          )
      );
      print "</pre>";
    }

    $trace = debug_backtrace();

    $p     = $trace[1]['function'] == 'pred' ? $trace[1] : $trace[0];
//            print("\n{$p['file']}@{$p['line']}<br />\n" . (is_string($die) ? 'Die message: ' . $die . "<br />\n" : ''));
    print("\n{$p['file']}@{$p['line']}<br />\n");
  }

  function pred() {
    call_user_func_array('pre', func_get_args());
    die();
  }
}