mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
61c89794e4
* Remove $debug global and $vdebug global makes these variables more accessible and protects from collisions. * the on boot set sends application as the first parameter, just handle that * Relocate other debug related functions * Log debug to stdout * Wrong output * remove stupid constants * Fix lint and style issues
138 lines
3.8 KiB
PHP
138 lines
3.8 KiB
PHP
<?php
|
|
/*
|
|
* Debug.php
|
|
*
|
|
* -Description-
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @package LibreNMS
|
|
* @link http://librenms.org
|
|
* @copyright 2021 Tony Murray
|
|
* @author Tony Murray <murraytony@gmail.com>
|
|
*/
|
|
|
|
namespace LibreNMS\Util;
|
|
|
|
use App;
|
|
use Illuminate\Database\Events\QueryExecuted;
|
|
use LibreNMS\DB\Eloquent;
|
|
use Log;
|
|
|
|
class Debug
|
|
{
|
|
private static $debug = false;
|
|
private static $verbose = false;
|
|
|
|
public static function set($debug = true, bool $silence = false): bool
|
|
{
|
|
self::$debug = (bool) $debug;
|
|
|
|
restore_error_handler(); // disable Laravel error handler
|
|
|
|
if (self::$debug) {
|
|
ini_set('display_errors', '1');
|
|
ini_set('display_startup_errors', '1');
|
|
ini_set('log_errors', '0');
|
|
error_reporting(E_ALL & ~E_NOTICE);
|
|
|
|
self::enableCliDebugOutput();
|
|
self::enableQueryDebug();
|
|
} else {
|
|
ini_set('display_errors', '0');
|
|
ini_set('display_startup_errors', '0');
|
|
ini_set('log_errors', '1');
|
|
error_reporting($silence ? 0 : E_ERROR);
|
|
|
|
self::disableCliDebugOutput();
|
|
self::disableQueryDebug();
|
|
}
|
|
|
|
return self::$debug;
|
|
}
|
|
|
|
/**
|
|
* Set debug without configuring error reporting.
|
|
*/
|
|
public static function setOnly(bool $debug = true): bool
|
|
{
|
|
return self::$debug = $debug;
|
|
}
|
|
|
|
public static function setVerbose(bool $verbose = true): void
|
|
{
|
|
self::$verbose = $verbose;
|
|
}
|
|
|
|
public static function isEnabled(): bool
|
|
{
|
|
return self::$debug;
|
|
}
|
|
|
|
public static function isVerbose(): bool
|
|
{
|
|
return self::$verbose;
|
|
}
|
|
|
|
public static function disableQueryDebug()
|
|
{
|
|
$db = Eloquent::DB();
|
|
|
|
if ($db) {
|
|
// remove all query executed event handlers
|
|
$db->getEventDispatcher()->flush('Illuminate\Database\Events\QueryExecuted');
|
|
}
|
|
}
|
|
|
|
public static function enableCliDebugOutput()
|
|
{
|
|
if (Laravel::isBooted() && App::runningInConsole()) {
|
|
Log::setDefaultDriver('console');
|
|
}
|
|
}
|
|
|
|
public static function disableCliDebugOutput()
|
|
{
|
|
if (Laravel::isBooted()) {
|
|
Log::setDefaultDriver('stack');
|
|
}
|
|
}
|
|
|
|
public static function enableQueryDebug()
|
|
{
|
|
static $sql_debug_enabled;
|
|
$db = Eloquent::DB();
|
|
|
|
if ($db && ! $sql_debug_enabled) {
|
|
$db->listen(function (QueryExecuted $query) {
|
|
// collect bindings and make them a little more readable
|
|
$bindings = collect($query->bindings)->map(function ($item) {
|
|
if ($item instanceof \Carbon\Carbon) {
|
|
return $item->toDateTimeString();
|
|
}
|
|
|
|
return $item;
|
|
})->toJson();
|
|
|
|
if (Laravel::isBooted()) {
|
|
Log::debug("SQL[%Y{$query->sql} %y$bindings%n {$query->time}ms] \n", ['color' => true]);
|
|
} else {
|
|
c_echo("SQL[%Y{$query->sql} %y$bindings%n {$query->time}ms] \n");
|
|
}
|
|
});
|
|
$sql_debug_enabled = true;
|
|
}
|
|
}
|
|
}
|