roundcubemail/plugins/debug_logger/runlog/runlog.php

<?php

/**
 * runlog
 *
 * @author Ziba Scott <ziba@umich.edu>
 */
class runlog
{
    private $parent_stack = [];
    private $file_handles = [];
    private $indent = 0;
    private $run_log = [];

    public $print_to_console = false;
    public $threshold = 0;
    public $tag_count = [];
    public $timestamp = 'd-M-Y H:i:s O';
    public $max_line_size = 150;

    public function start($name, $tag = false)
    {
        $this->run_log[] = [
            'type' => 'start',
            'tag' => $tag,
            'index' => count($this->run_log),
            'value' => $name,
            'time' => microtime(true),
            'parents' => $this->parent_stack,
            'ended' => false,
        ];

        $this->parent_stack[] = $name;

        $this->print_to_console('start: ' . $name, $tag);
        $this->print_to_file('start: ' . $name, $tag);
        $this->indent++;
    }

    public function end()
    {
        $name = array_pop($this->parent_stack);
        $lastk = 0;

        foreach ($this->run_log as $k => $entry) {
            if ($entry['value'] == $name && $entry['type'] == 'start' && !$entry['ended']) {
                $lastk = $k;
            }
        }

        $start = $this->run_log[$lastk]['time'];
        $this->run_log[$lastk]['duration'] = microtime(true) - $start;
        $this->run_log[$lastk]['ended'] = true;
        $this->run_log[] = [
            'type' => 'end',
            'tag' => $this->run_log[$lastk]['tag'],
            'index' => $lastk,
            'value' => $name,
            'time' => microtime(true),
            'duration' => microtime(true) - $start,
            'parents' => $this->parent_stack,
        ];

        $this->indent--;
        if ($this->run_log[$lastk]['duration'] >= $this->threshold) {
            $tag_report = '';
            foreach ($this->tag_count as $tag => $count) {
                $tag_report .= "{$tag}: {$count}, ";
            }
            $end_txt = sprintf("end: {$name} - %0.4f seconds {$tag_report}", $this->run_log[$lastk]['duration']);
            $this->print_to_console($end_txt, $this->run_log[$lastk]['tag']);
            $this->print_to_file($end_txt, $this->run_log[$lastk]['tag']);
        }
    }

    public function increase_tag_count($tag)
    {
        if (!isset($this->tag_count[$tag])) {
            $this->tag_count[$tag] = 0;
        }

        $this->tag_count[$tag]++;
    }

    public function get_text()
    {
        $text = '';
        foreach ($this->run_log as $entry) {
            $text .= str_repeat('   ', count($entry['parents']));
            if ($entry['tag'] != 'text') {
                $text .= $entry['tag'] . ': ';
            }
            $text .= $entry['value'];

            if ($entry['tag'] == 'end') {
                $text .= sprintf(' - %0.4f seconds', $entry['duration']);
            }

            $text .= "\n";
        }

        return $text;
    }

    public function set_file($filename, $tag = 'master')
    {
        if (!isset($this->file_handles[$tag])) {
            $this->file_handles[$tag] = fopen($filename, 'a');
            if (!$this->file_handles[$tag]) {
                trigger_error("Could not open file for writing: {$filename}");
            }
        }
    }

    public function note($msg, $tag = false)
    {
        if ($tag) {
            $this->increase_tag_count($tag);
        }
        if (is_array($msg)) {
            $msg = '<pre>' . print_r($msg, true) . '</pre>';
        }
        $this->run_log[] = [
            'type' => 'note',
            'tag' => $tag ?: 'text',
            'value' => htmlentities($msg),
            'time' => microtime(true),
            'parents' => $this->parent_stack,
        ];

        $this->print_to_file($msg, $tag);
        $this->print_to_console($msg, $tag);
    }

    public function print_to_file($msg, $tag = false)
    {
        $file_handle_tag = $tag ?: 'master';

        if ($file_handle_tag != 'master' && isset($this->file_handles[$file_handle_tag])) {
            $buffer = $this->get_indent();
            $buffer .= "{$msg}\n";
            if (!empty($this->timestamp)) {
                $buffer = sprintf('[%s] %s', date($this->timestamp, time()), $buffer);
            }
            fwrite($this->file_handles[$file_handle_tag], wordwrap($buffer, $this->max_line_size, "\n     "));
        }

        if (isset($this->file_handles['master']) && $this->file_handles['master']) {
            $buffer = $this->get_indent();
            if ($tag) {
                $buffer .= "{$tag}: ";
            }
            $msg = str_replace("\n", '', $msg);
            $buffer .= $msg;
            if (!empty($this->timestamp)) {
                $buffer = sprintf('[%s] %s', date($this->timestamp, time()), $buffer);
            }
            if (strlen($buffer) > $this->max_line_size) {
                $buffer = substr($buffer, 0, $this->max_line_size - 3) . '...';
            }
            fwrite($this->file_handles['master'], $buffer . "\n");
        }
    }

    public function print_to_console($msg, $tag = false)
    {
        if ($this->print_to_console) {
            if (is_array($this->print_to_console)) {
                if (in_array($tag, $this->print_to_console)) {
                    echo $this->get_indent();
                    if ($tag) {
                        echo "{$tag}: ";
                    }
                    echo "{$msg}\n";
                }
            } else {
                echo $this->get_indent();
                if ($tag) {
                    echo "{$tag}: ";
                }
                echo "{$msg}\n";
            }
        }
    }

    private function get_indent()
    {
        $buf = '';
        for ($i = 0; $i < $this->indent; $i++) {
            $buf .= '  ';
        }

        return $buf;
    }

    public function __destruct()
    {
        foreach ($this->file_handles as $handle) {
            fclose($handle);
        }
    }
}