librenms-librenms/LibreNMS/Util/Laravel.php

<?php
/**
 * Laravel.php
 *
 * Utility class to gather code to do
 *
 * 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  2018 Tony Murray
 * @author     Tony Murray <murraytony@gmail.com>
 */

namespace LibreNMS\Util;

use App;
use Illuminate\Database\Events\QueryExecuted;
use LibreNMS\Config;
use LibreNMS\DB\Eloquent;
use Log;

class Laravel
{
    public static function enableQueryDebug()
    {
        $db = Eloquent::DB();

        if ($db && !$db->getEventDispatcher()->hasListeners('Illuminate\Database\Events\QueryExecuted')) {
            $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 (class_exists('Log')) {
                    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");
                }
            });
        }
    }

    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 (class_exists('Log')) {
            $logger = Log::getMonolog();

            // only install if not existing
            $install = true;
            $logfile = Config::get('log_file', base_path('logs/librenms.log'));
            foreach ($logger->getHandlers() as $handler) {
                if ($handler instanceof \Monolog\Handler\StreamHandler) {
                    if ($handler->getUrl() == 'php://stdout') {
                        $install = false;
                    } elseif ($handler->getUrl() == $logfile) {
                        // send to librenms log file if not a cli app
                        if (!App::runningInConsole()) {
                            set_error_handler(function ($errno, $errstr, $errfile, $errline) {
                                Log::error("$errno $errfile:$errline $errstr");
                            });
                            $handler->setLevel(\Monolog\Logger::DEBUG);
                        }
                    }
                }
            }

            if ($install) {
                $handler = new \Monolog\Handler\StreamHandler(
                    'php://stdout',
                    \Monolog\Logger::DEBUG
                );

                $handler->setFormatter(new CliColorFormatter());

                $logger->pushHandler($handler);
            }
        }
    }

    public static function disableCliDebugOutput()
    {
        if (class_exists('Log')) {
            $handlers = Log::getMonolog()->getHandlers();
            if (isset($handlers[0]) && $handlers[0]->getUrl() == 'php://stdout') {
                Log::getMonolog()->popHandler();
            }
        }
    }
}