dev.inc

<?php
function array_contents(&$array, $max_depth=0, $ignore_ints=FALSE, $depth=0)
{
    $string = $indent = '';
    for ($i = 0; $i < $depth; $i++) {
        $indent .= "\t";
    }
    if (!empty($max_depth) && $depth >= $max_depth) {
        return $indent."[Max Depth Reached]\n";
    }
    if (count($array) == 0) return $indent."[Empty]\n";
    reset($array);
    while (list($key,$value) = each($array)) {
        $print_key = str_replace("\n","\\n",str_replace("\r","\\r",str_replace("\t","\\t",addslashes($key))));
        if ($ignore_ints && gettype($key) == 'integer') {
            continue;
        }
        $type = gettype($value);
        if ($type == 'array' || $type == 'object') {
            $string .= $indent
                    .((is_string($key)) ? "\"$print_key\"": $key).' => '
                    .(($type == 'array') ? "array (\n" : '')
                    .(($type == 'object') ? 'new '.get_class($value)." Object (\n" : '');
            $string .= array_contents($value, $max_depth, $ignore_ints, $depth + 1);
            $string .= $indent."),\n";
        } else {
            if (is_string($value)) {
                $value = str_replace("\n","\\n",str_replace("\r","\\r",str_replace("\t","\\t",addslashes($value))));
            }
            $string .= $indent
                    .((is_string($key)) ? "\"$print_key\"" : $key).' => '
                    .((is_string($value)) ? "\"$value\"" : $value).",\n";
        }
    }
    $string[ strlen($string) - 2 ] = ' ';
    return $string;

}//end array_contents()


function ascii_chart()
{
    for ($i=0; $i<256; $i++) {
        echo(($i==0) ? '<table><tr>' : '')."<td>$i:</td><td>".chr($i).'</td><td>&nbsp;</td>'.((7==($i%8)) ? '</tr><tr>' : '').(($i==255) ? '</tr></table>' : '');
    }

}//end ascii_chart()


function inject_beef()
{
    $check = '';
    list($msec, $sec) = explode(' ',microtime());
    $BAM = ((double) $sec) + ((double) $msec);
    // Record time (note we ignore time spent IN this function)
    global $SPEED_CHECK_LAST_HIT, $SPEED_CHECK_TOTAL;
    if ($SPEED_CHECK_LAST_HIT) {
        $elapsed = $BAM - $SPEED_CHECK_LAST_HIT;
        $SPEED_CHECK_TOTAL += $elapsed;
        $check = sprintf('%.5f / %.5f',$elapsed,$SPEED_CHECK_TOTAL);
    }

    list($msec, $sec) = explode(' ',microtime());
    // initialize
    $SPEED_CHECK_LAST_HIT = ((double) $sec) + ((double) $msec);

    $len = strlen($check);
    if (!$len) return;

    static $i;
    $i++;
    $string = '
        .--,       '.str_repeat(' ',$len).'       ,--.
        l_/ \     _'.str_repeat('_',$len).'_     / \_J
         \   `-./__'.str_repeat('_',$len).'__\.-\'   /
          `..---'.str_repeat('-',$len).'----..\'
            `-/    '.str_repeat(' ',$len).'     \'
              |    '.$check.'     |
               `.__'.str_repeat('_',$len).'___.\'
    ';
    pre_echo($string);

}//end inject_beef()


function bam($x='BAM!', $max_depth=0, $style='')
{
    pre_echo($x, $max_depth, $style);

}//end bam()


function minibam($contents, $title='BAM', $max_depth=0, $auto_expand=FALSE)
{
    if (defined('SQ_DEBUG_HIDE_MINIBAM') && SQ_DEBUG_HIDE_MINIBAM) {
        return;
    }

    if (php_sapi_name() == 'cli') {

        echo "\n------------------------------------\n";
        echo $title;
        pre_echo($contents, $max_depth);
        
    } else {
    
        $id = rawurlencode(strtolower($title)).'_'.microtime();
        ?>
        <table border="1" cellspacing="0" cellpadding="2" style="background-color: #FFDDDD; color: #000000;">
            <tr>
                <td style="cursor: pointer; cursor: hand; text-decoration: underline; font-weight: bold" onclick="elt = document.getElementById('<?php echo $id; ?>'); elt.style.display = (elt.style.display == 'none') ? '' : 'none';"><?php echo $title; ?></a></td>
            </tr>
            <tr>
                <td id="<?php echo $id; ?>" style="display: <?php echo ($auto_expand ? '' : 'none'); ?>">
                    <?php pre_echo($contents, $max_depth); ?>
                </td>
            </tr>
        </table>
        <?php
        
    }//end if (php_sapi_name())

}//end minibam()


function pre_echo($x, $max_depth=0, $style='')
{
    if (php_sapi_name() == 'cli') {
        echo "\n------------------------------------\n";
    } else {
        echo "\n", '<div align="left"><pre style="', $style, 'font-family: courier, monospace;">';
    }

    $type = gettype($x);
    if ($type == 'object' && !$max_depth) {
        print_r($x);
    } else {
        if ($type == 'object' || $type == 'array') {
            // get the contents, then
            if (!$max_depth) $max_depth = 10;
            $x = array_contents($x, $max_depth);
        }
        $x = str_replace("\t", '    ', $x);

        echo (php_sapi_name() == 'cli') ? $x : htmlspecialchars($x);
    }

    if (php_sapi_name() == 'cli') {
        echo "\n------------------------------------\n";
    } else {
        echo '</pre></div>', "\n";
    }

}//end pre_echo()


function speed_check($str='', $html=TRUE, $log_error=TRUE, $log_file = '')
{
    list($msec, $sec) = explode(' ',microtime());
    // Record time (note we ignore time spent IN this function)
    $BAM = ((double) $sec) + ((double) $msec);

    global $SPEED_CHECK_LAST_HIT, $SPEED_CHECK_TOTAL;
    if ($SPEED_CHECK_LAST_HIT) {
        $elapsed = $BAM - $SPEED_CHECK_LAST_HIT;
        $SPEED_CHECK_TOTAL += $elapsed;
        if ($html) {
            echo('<table cellpadding=0 cellspacing=0 border=0 bgcolor="#ffff88"><tr><td><p style="color:red;font-weight:bold;font-family:sans-serif;font-size:13px;">'.sprintf('%.5f&nbsp;/&nbsp;%.5f',$elapsed,$SPEED_CHECK_TOTAL)."&nbsp;&nbsp;$str</p></td></tr></table>");
        } else {
            if (!$log_error) {
                echo sprintf('%.5f/%.5f', $elapsed, $SPEED_CHECK_TOTAL).' '.$str;
            } else {
                if ($log_file == '') {
                    error_log(sprintf('%.5f/%.5f', $elapsed, $SPEED_CHECK_TOTAL).' '.$str);
                } else {
                    log_write(sprintf('%.5f/%.5f', $elapsed, $SPEED_CHECK_TOTAL).' '.$str, $log_file);
                }
            }
        }

    }
    list($msec, $sec) = explode(' ',microtime());
    // initialize
    $SPEED_CHECK_LAST_HIT = ((double) $sec) + ((double) $msec);

}//end speed_check()


function mem_check($print=NULL, $return_value=FALSE, $start_over=FALSE)
{
    global $MEM_CHECK_FIRST_HIT, $MEM_CHECK_LAST_HIT;
    if ($start_over) {
        $MEM_CHECK_FIRST_HIT = 0;
        $MEM_CHECK_LAST_HIT = 0;
    }

    $hit = (int) (memory_get_usage() / 1024);
    $mem = '';
    if (is_null($print) || in_array('current', $print)) {
        $mem = $hit.' KB';
    }

    if ($MEM_CHECK_LAST_HIT) {
        if (is_null($print) || in_array('change', $print)) {
            if ($hit > $MEM_CHECK_LAST_HIT) {
                $mem .= ' (+ '.($hit - $MEM_CHECK_LAST_HIT).' KB)';
            }
            if ($hit < $MEM_CHECK_LAST_HIT) {
                $mem .= ' (- '.($MEM_CHECK_LAST_HIT - $hit).' KB)';
            }
        }
    }

    if ($MEM_CHECK_FIRST_HIT) {
        if (is_null($print) || in_array('total', $print)) {
            if ($hit > $MEM_CHECK_FIRST_HIT) {
                $mem .= ' [+ '.($hit - $MEM_CHECK_FIRST_HIT).' KB TOTAL]';
            }
            if ($hit < $MEM_CHECK_FIRST_HIT) {
                $mem .= ' [- '.($MEM_CHECK_FIRST_HIT - $hit).' KB TOTAL]';
            }
        }
    } else {
        $MEM_CHECK_FIRST_HIT = $hit;
    }

    if (!$return_value) {
        echo("<br><table cellpadding=0 cellspacing=0 border=0 bgcolor=#ffff88><tr><td><p style=\"color:red;font-weight:bold;font-family:sans-serif;font-size:13px;\">Mem: $mem</td></tr></table><br>");
    }

    $MEM_CHECK_LAST_HIT = $hit;
    if ($return_value) return $mem;

}//end mem_check()


function print_function_list()
{
    echo '<pre>';
    foreach (get_loaded_extensions() as $extension) {
        echo "<b>Extension: $extension</b><br>";
        print_r (get_extension_funcs($extension));
    }
    echo '<b>User-defined</b><br>';
    $f = get_defined_functions();
    print_r ($f['user']);
    foreach (get_declared_classes() as $class) {
        echo "<b>Class Methods: $class</b><br>";
        print_r(get_class_methods($class));
    }
    echo '</pre>';

}//end print_function_list()


function pts_spew($i,$s)
{
    if ($i != (int) $i || !file_exists("/dev/pts/$i")) {
        trigger_error("Can't spew to pts, \"$i\" is not a valid pts number.", E_USER_WARNING);
        return;
    }
    require_once(dirname(__FILE__).'/../general/file_system.inc');
    if (!string_to_file("$s\n","/dev/pts/$i")) {
        trigger_error("Try ensuring that /dev/pts/[your_pts_number] is writable by the web server.<br>$ w  # To find your pts<br>$ chmod a+w /dev/pts/[your_pts_number]<br>", E_USER_WARNING);
    }

}//end pts_spew()


function get_calling_func()
{

    $bt = debug_backtrace();
    $file = substr($bt[1]['file'], strrpos($bt[1]['file']+1, '/'));
    $res = '';
    if (isset($bt[2])) {
        if (isset($bt[2]['class'])) {
            $res = $bt[2]['class'].'::'.$bt[2]['function'];
        } else {
            $res = $bt[2]['function'];
        }
    }
    $res .= ' ('.$file.' line '.$bt[1]['line'].')';
    return $res;

}//end get_calling_func()


function get_backtrace()
{
    $bt = debug_backtrace();
    // remove this function call from the stack
    array_shift($bt);
    $stack = Array();

    foreach ($bt as $elem) {
        $info = '';
        if (isset($elem['line'])) $info = 'line='.$elem['line'];
        $file = '';

        if (isset($elem['file'])) {
            $file = basename($elem['file']);
            substr($file, 0, strpos($file, '.'));
        }

        $class_name = substr($file, 0, strpos($file, '.'));
        if (empty($elem['class'])) {
            $info .= ' file='.$file;
        } else {
            if ($class_name != $elem['class']) {
                $info .= ' class='.$class_name.' object='.$elem['class'];
            } else {
                $info .= ' class='.$elem['class'];
            }
        }
        $stack[] = 'function '.$elem['function'].'('.$info.')';
    }
    return $stack;

}//end get_backtrace()


function get_microtime()
{
    list($usec, $sec) = explode(' ', microtime());
    return $sec + $usec;

}//end get_microtime()


function log_dump($var=NULL)
{
    static $count = 0;
    if (is_null($var)) {
        $var = '---------- Debugging ----------';
    }
    error_log("\n".$count++.': '.get_calling_func().": \n".print_r($var, 1));

}//end log_dump()


?>