Merge branch 'develop'

TechyShishy · Sep 2, 2011 · faf62f6 · faf62f6
2 parents e767e5c + 84882b2
commit faf62f6
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 2 deletions.
diff --git a/Classes/TraceFile.php b/Classes/TraceFile.php
@@ -67,6 +67,10 @@ private function parse($lines)
 			{
 				$current_function = $current_function->do_return(new FunctionEventReturn($parsed_line));
 			}
+
+            // Currently doesn't handle Uncaught Exceptions or Errors.
+            if($current_function === null)
+                break;
         }
     }
 	public static function read_line($line)

diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+What Goes In is a php library to visualize variable usage in a project. In short, it provides a tool to trace the path a variable takes through an application, and identify every usage of it, or of decendants of it (string concatenation, etc). This provides an easy interface to help determine the impact of an insecure variable.
+
+What Goes In depends upon the concept that at some level everything you can do to user-input that might be harmful depends upon calling a function.  This library will be able to accept several types of input, and produce several types of output.  It currently accepts only xdebug trace files created in machine readable mode, and outputs only to an html page with some basic styling.  A large porition of this still requires a heavy user tax.  At this stage, this is unavoidable.  In the future, the library should automate most of these tasks.
+
+NOTE: This library is designed to read into memory multi-megabyte trace files, and parse the whole thing in one go, then display the whole thing to the user.  This is expensive both in terms of memory, cpu-time, and bandwidth.  Future version may allow some form of incremental parsing, but fundamentally, if you're trying to trace a variable through an application, you need to see every function call.
+
+In order to use What Goes In, you'll need the following lines appended to your php.ini.
+
+	zend_extension="/usr/lib/php/extensions/xdebug.so" ; Configurable, location of your xdebug.so
+
+	[xdebug]
+	xdebug.auto_trace = 1                              ; Required.  If you have xdebug 2.2, you can use xdebug.trace_trigger instead.
+	xdebug.trace_format = 1                            ; Required.
+	xdebug.trace_options = 0                           ; Required.
+	xdebug.trace_output_dir = /output/xdebug/          ; Configurable, but make sure the apache user has write access.
+	xdebug.trace_output_name = trace.%R.%u.%r          ; Configurable, see xdebug docs for information.
+	xdebug.collect_params = 4                          ; Required.
+	xdebug.collect_return = 1                          ; Required.
+	xdebug.collect_assignments = 1                     ; Required.
+	xdebug.collect_includes = 1                        ; Required.
+
diff --git a/index.php b/index.php
@@ -9,7 +9,25 @@
     <body>
         <form action="" method="GET">
             <label for="file">File:</label>
-            <input id="file" name="file" type="text" />
+            <select id="file" name="file">
+<?php
+
+	echo '<option value="" selected="selected"> -- Select -- </option>';
+
+	$files = new DirectoryIterator ( ini_get('xdebug.trace_output_dir') );
+	foreach ( $files as $file ) {
+
+		if (substr_count ( $file->getFilename (), '.xt' ) == 0 || in_array($config['directory'] . '/' . $file->getFilename(), $ownTraces)) {
+			continue;
+		}
+
+		$date = explode ( '.', $file->getFilename () );
+		$date = date ( 'Y-m-d H:i:s', $date [0] );
+
+		echo '<option value="' . $file->getFilename () . '"> ' . $date . ' - ' . $file->getFilename () . ' </option>';
+	}
+?>
+            </select>
             <input type="submit" />
         </form>
 <?php
@@ -21,7 +39,7 @@
                 <li>
 <?php
     include_once('Classes/TraceFile.php');
-    $file = new TraceFile($_GET['file']);
+    $file = new TraceFile(realpath(ini_get('xdebug.trace_output_dir').$_GET['file']));
     $main = $file->get_main();
     echo $main->do_print();
 ?>