Changeset 389439

Timestamp:

05/26/2011 04:18:06 PM (15 years ago)

Author:

kunalb

Message:

Added support for logging debug messages as well as a corresponding screenshot.

Location:

kb-debug/trunk

Files:

• 2.png (added)
• README (modified) (5 diffs)
• kb-debug.css (modified) (3 diffs)
• kb_debug.php (modified) (7 diffs)

kb-debug/trunk/README

@@ -4 +4 @@
 Requires at least: WordPress 3.0
 Tested up to: 3.2
-Stable tag: 0.1
+Stable tag: 0.2
 
 Debug your plugins and themes.
@@ -10 +10 @@
 == Description ==
 
-To log and show a list of all warnings, errors and notices generated by your plugin, add a ?KB_Debug_Errors to your URL. To see a list of all hooks in the order they fire as well as what arguments they are called with and what functions run on them (again, in which order), add a ?KB_Debug_Hooks to the URL.
+* Call `kb_debug` with any arguments that you want to log and they will be pretty printed at the end of the document.
+* To log and show a list of all warnings, errors and notices generated by your plugin, add  `?KB_Debug_Errors` to your URL. 
+* To see a list of all hooks in the order they fire as well as what arguments they are called with and what functions run on them (again, in which order),
+  add a `?KB_Debug_Hooks` to the URL.
 
 To see both just add ?KB_Debug_Errors&KB_Debug_Hooks. (Essentially $_GET[var] must be set to enable that feature).
@@ -16 +19 @@
 
 == Installation ==
-
 Upload `kb_debug.php` and 'kb-debug.css' to the `/wp-content/mu-plugins/` directory. (Create this directory if it doesn't exist).
 
@@ -31 +33 @@
 == Screenshots ==
 1. Showing how errors and hooks appear on using this plugin. 
+2. Showing how debugging information is shown in the plugin.
 
 == Changelog ==
@@ -40 +43 @@
 
 = 0.1 =
-First version.
+* First version.

kb-debug/trunk/kb-debug.css

@@ -12 +12 @@
 
 .effect-border {
+    border-top: solid 1px #fff;
+    border-bottom: solid 1px #dfdfdf;
+    border-radius: 3px 3px 0 0;
+    padding: 10px;
+}
+
+#kb-debug {
+    background-color: #f0f0f0;
+    color: #111;
+    text-shadow: #fff 0 1px 0;
+    border-radius: 3px 3px 0 0;
+    border: solid 1px #ccc;
+    margin: 10px;
+    font-family: sans-serif;
+    font-size: 12px;
+    line-height: 20px;
+}
+
+#kb-debug .effect-border {
     border-top: solid 1px #fff;
     border-bottom: solid 1px #dfdfdf;
@@ -35 +54 @@
             border-bottom: solid #dfdfdf 1px;
             padding: 2px;
+            margin: 0;
         }
 
@@ -54 +74 @@
                 width: 95%;
                 overflow: auto;
+                padding: 10px;
+                margin: 10px;
             }
 

kb-debug/trunk/kb_debug.php

@@ -46 +46 @@
 
 /**
- * The Base Class used to save errors and warnings information, if any.
+ * Used to save debugging information logged by the user.
+ */ 
+class KB_Debug {
+
+    /**
+     * Store any errors, notices, warnings or debug information.
+     * @access private
+     * @var Array
+     */
+    private $logged;
+
+    /**
+     * Constructor. Initializes values and assigns actions.
+     */
+    public function __construct() {
+        $this->logged = Array();
+
+        add_action( 'shutdown', Array( &$this, 'display' ), 98 );
+        wp_enqueue_style( 'kb-debug-css', KB_DEBUG_RELURL . "/kb-debug.css" ); 
+    }
+
+    /**
+     * Display all logged debugging information.
+     * @access public
+     */
+    function display() {
+        echo "<div class = 'kb-debug-box' id = 'kb-debug'><div class = 'effect-border'>";
+        echo "<h2>Logged</h2>"; 
+        echo "<ul>";
+        foreach( $this->logged as $log ) {
+            echo "<li>";
+            echo "<h3>{$log->backtrace['line']}, {$log->backtrace['file']}</h3>";
+            foreach( $log->data as $data ) {
+                echo "<pre>"; print_r( $data ); echo "</pre>";
+            }
+            echo "</li>";
+        }
+        echo "</ul>";
+        echo "</div></div>";
+    }
+
+    /**
+     * Log array of arguments passed to it. Later pretty printed with a backtrace using print_r.
+     * Do not call this function directly.
+     * @access public
+     */
+    function log( $arglist ) {
+        $log = new STDClass();
+        $log->data = $arglist;
+        $backtrace = debug_backtrace();
+        $log->backtrace = $backtrace[1];
+
+        $this->logged[] = $log;
+    }
+
+}
+ 
+
+/**
+ * Used to save errors and warnings information, if any.
  * @package KB_Debug
  */
@@ -64 +123 @@
      */
     private $counters;
+
+    /**
+     * Warning in case an existing error handler is removed.
+     * @access private
+     * @var String
+     */
+    private $message; 
 
     /**
@@ -77 +143 @@
         $this->counters->notices  = 0;
 
-        add_action( 'shutdown', Array( &$this, 'display' ) );
-        set_error_handler( Array( &$this, 'log' ) );
+        add_action( 'shutdown', Array( &$this, 'display' ), 99 );
+        $original_handler = set_error_handler( Array( &$this, 'log' ) );
+
+        $this->message = "";
+        if( $original_handler != NULL )
+            $this->message = "<p>Warning: An existing error handler was replaced." . print_r( $original_handler, true ) . "</p>";
 
         wp_enqueue_style( 'kb-debug-css', KB_DEBUG_RELURL . "/kb-debug.css" ); 
@@ -90 +160 @@
         echo "<div class = 'kb-debug-box'><div class = 'effect-border'>";
         echo "<h2>Errors and Warnings</h2>";    
+        echo $this->message;
         echo "<ul>";
         foreach( $this->logged as $log ) {
@@ -112 +183 @@
             echo "<pre style = 'max-height: 100px;'>"; print_r($log['context']); echo "</pre>";
 
-
             echo "</li>";
         }
@@ -170 +240 @@
 
         add_action( 'all', Array( &$this, 'log' ) );
-        add_action( 'shutdown', Array( &$this, 'display' ) );
+        add_action( 'shutdown', Array( &$this, 'display' ), 100 );
 
         wp_enqueue_style( 'kb-debug-css', KB_DEBUG_RELURL . "/kb-debug.css" ); 
@@ -228 +298 @@
  */
 if (defined ('WP_DEBUG') && WP_DEBUG) {
-    if( isset( $_GET['KB_Debug_Errors'] ) )
+    
+    /**
+     * Call this function to save any data. Records calling information via a stack trace.
+     */
+    function kb_debug() {
+        static $kdb;
+        if ( !isset( $kdb ) ) $kdb = new KB_Debug();
+
+        $kdb->log( func_get_args() );
+    }
+
+    if( isset( $_GET['KB_Debug_Errors'] ) || ( defined( 'KB_DEBUG' ) && KB_DEBUG ) )
         new KB_Debug_Errors();
-    if( isset( $_GET['KB_Debug_Hooks'] ) )
+    if( isset( $_GET['KB_Debug_Hooks'] ) || ( defined( 'KB_DEBUG' ) && KB_DEBUG ) )
         new KB_Debug_Hooks();
 }
-
-
-/* 2. Reset capabilities to initial state if KB_RESET_CAPS is set in $_GET */
-
-/**
- * Reverts capabilities to default state. 
- *
- * Useful while debugging.
- */
-function kb_reset_caps() {
-    global $wpdb;
-    $key = $wpdb->prefix . 'user_roles';
-
-    //Bye, bye, existing caps
-    delete_option( $key );
-
-    //Repopulate
-    require_once( "/home/kunalb/dev/eventpress/wp-admin/includes/schema.php" );
-    populate_roles();
-}
-if (isset( $_GET['KB_RESET_CAPS'] ))
-    add_action( 'init', kb_reset_caps );