Back to index

php5  5.3.10
Enumerations | Functions | Variables
check_parameters.php File Reference

Go to the source code of this file.

Enumerations

enum  REPORT_LEVEL
enum  VERSION
enum  PHPDIR

Functions

if(version_compare(VERSION,
'6', 'ge')) 
error ($str, $level=0)
 reports an error, according to its level
 update_lineno ($offset)
 this updates the global var $line (for error reporting)
 get_vars ($txt)
 parses the sources and fetches its vars name, type and if they are initialized or not
 check_param ($db, $idx, $exp, $optional)
 run diagnostic checks against one var.
 get_params ($vars, $str)
 fetch params passed to zend_parse_params*()
 check_function ($name, $txt, $offset)
 run tests on a function.
 recurse ($path)
 the main recursion function.

Variables

 $API_params
 $dirs = array()
if(isset($argc)&&$argc > 1) else $dirs [] = PHPDIR

Enumeration Type Documentation

enum PHPDIR

Definition at line 25 of file check_parameters.php.

Definition at line 23 of file check_parameters.php.

enum VERSION

Definition at line 24 of file check_parameters.php.


Function Documentation

check_function ( name,
txt,
offset 
)

run tests on a function.

the code is passed in $txt

Definition at line 199 of file check_parameters.php.

{
       global $API_params;

       if (preg_match_all('/zend_parse_parameters(?:_ex\s*\([^,]+,[^,]+|\s*\([^,]+),\s*"([^"]*)"\s*,\s*([^{;]*)/S', $txt, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE)) {

              $GLOBALS['current_function'] = $name;

              foreach ($matches as $m) {
                     $GLOBALS['error_few_vars_given'] = false;
                     update_lineno($offset + $m[2][1]);

                     $vars = get_vars(substr($txt, 0, $m[0][1])); // limit var search to current location
                     $params = get_params($vars, $m[2][0]);
                     $optional = $varargs = false;
                     $last_last_char = $last_char = '';
                     $j = -1;
                     $len = strlen($m[1][0]);

                     for ($i = 0; $i < $len; ++$i) {
                            switch($char = $m[1][0][$i]) {
                                   // separator for optional parameters
                                   case '|':
                                          if ($optional) {
                                                 error("more than one optional separator at char #$i");
                                          } else {
                                                 $optional = true;
                                                 if ($i == $len-1) {
                                                        error("unnecessary optional separator");
                                                 }
                                          }
                                   break;

                                   // separate_zval_if_not_ref
                                   case '/':
                                          if (!in_array($last_char, array('r', 'z'))) {
                                                 error("the '/' specifier cannot be applied to '$last_char'");
                                          }
                                   break;

                                   // nullable arguments
                                   case '!':
                                          if (!in_array($last_char, array('a', 'C', 'f', 'h', 'o', 'O', 'r', 's', 't', 'z', 'Z'))) {
                                                 error("the '!' specifier cannot be applied to '$last_char'");
                                          }
                                   break;

                                   case '&':
                                          if (version_compare(VERSION, '6', 'ge')) {
                                                 if ($last_char == 's' || ($last_last_char == 's' && $last_char == '!')) {
                                                        check_param($params, ++$j, 'UConverter*', $optional);

                                                 } else {
                                                        error("the '&' specifier cannot be applied to '$last_char'");
                                                 }
                                          } else {
                                                 error("unknown char ('&') at column $i");
                                          }
                                   break;

                                   case '+':
                                   case '*':
                                          if (version_compare(VERSION, '6', 'ge')) {
                                                 if ($varargs) {
                                                        error("A varargs specifier can only be used once. repeated char at column $i");
                                                 } else {
                                                        check_param($params, ++$j, 'zval****', $optional);
                                                        check_param($params, ++$j, 'int*', $optional);
                                                        $varargs = true;
                                                 }
                                          } else {
                                                 error("unknown char ('$char') at column $i");
                                          }
                                   break;

                                   default:
                                          if (isset($API_params[$char])) {
                                                 foreach($API_params[$char] as $exp) {
                                                        check_param($params, ++$j, $exp, $optional);
                                                 }
                                          } else {
                                                 error("unknown char ('$char') at column $i");
                                          }
                            }

                            $last_last_char = $last_char;
                            $last_char = $char;
                     }
              }
       }
}

Here is the call graph for this function:

Here is the caller graph for this function:

check_param ( db,
idx,
exp,
optional 
)

run diagnostic checks against one var.

Definition at line 138 of file check_parameters.php.

{
       global $error_few_vars_given;

       if ($idx >= count($db)) {
              if (!$error_few_vars_given) {
                     error("too few variables passed to function");
                     $error_few_vars_given = true;
              }
              return;
       } elseif ($db[$idx][0] === '**dummy**') {
              return;
       }

       if ($db[$idx][1] != $exp) {
              error("{$db[$idx][0]}: expected '$exp' but got '{$db[$idx][1]}' [".($idx+1).']');
       }

       if ($optional && !$db[$idx][2]) {
              error("optional var not initialized: {$db[$idx][0]} [".($idx+1).']', 1);

       } elseif (!$optional && $db[$idx][2]) {
              error("not optional var is initialized: {$db[$idx][0]} [".($idx+1).']', 2);
       }
}

Here is the call graph for this function:

Here is the caller graph for this function:

if (version_compare(VERSION, '6', 'ge')) error ( str,
level = 0 
)

reports an error, according to its level

Definition at line 62 of file check_parameters.php.

{
       global $current_file, $current_function, $line;

       if ($level <= REPORT_LEVEL) {
              if (strpos($current_file,PHPDIR) === 0) {
                     $filename = substr($current_file, strlen(PHPDIR)+1); 
              } else {
                     $filename = $current_file;
              }
              echo $filename , " [$line] $current_function : $str\n";
       }
}
get_params ( vars,
str 
)

fetch params passed to zend_parse_params*()

Definition at line 166 of file check_parameters.php.

{
       $ret = array();
       preg_match_all('/(?:\([^)]+\))?(&?)([\w>.()-]+(?:\[\w+\])?)\s*,?((?:\)*\s*=)?)/S', $str, $m, PREG_SET_ORDER);

       foreach ($m as $x) {
              $name = $x[2];

              // little hack for last parameter
              if (strpos($name, '(') === false) {
                     $name = rtrim($name, ')');
              }

              if (empty($vars[$name][0])) {
                     error("variable not found: '$name'", 3);
                     $ret[][] = '**dummy**';

              } else {
                     $ret[] = array($name, $vars[$name][0] . ($x[1] ? '*' : ''), $vars[$name][1]);
              }

              // the end (yes, this is a little hack :P)
              if ($x[3]) {
                     break;
              }
       }

//     if ($GLOBALS['current_function'] == 'for_debugging') { var_dump($m); var_dump($ret); }
       return $ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_vars ( txt)

parses the sources and fetches its vars name, type and if they are initialized or not

Definition at line 113 of file check_parameters.php.

{
       $ret =  array();
       preg_match_all('/((?:(?:unsigned|struct)\s+)?\w+)(?:\s*(\*+)\s+|\s+(\**))(\w+(?:\[\s*\w*\s*\])?)\s*(?:(=)[^,;]+)?((?:\s*,\s*\**\s*\w+(?:\[\s*\w*\s*\])?\s*(?:=[^,;]+)?)*)\s*;/S', $txt, $m, PREG_SET_ORDER);

       foreach ($m as $x) {
              // the first parameter is special
              if (!in_array($x[1], array('else', 'endif', 'return'))) // hack to skip reserved words
                     $ret[$x[4]] = array($x[1] . $x[2] . $x[3], $x[5]);

              // are there more vars?
              if ($x[6]) {
                     preg_match_all('/(\**)\s*(\w+(?:\[\s*\w*\s*\])?)\s*(=?)/S', $x[6], $y, PREG_SET_ORDER);
                     foreach ($y as $z) {
                            $ret[$z[2]] = array($x[1] . $z[1], $z[3]);
                     }
              }
       }

//     if ($GLOBALS['current_function'] == 'for_debugging') { print_r($m);print_r($ret); }
       return $ret;
}

Here is the caller graph for this function:

recurse ( path)

the main recursion function.

splits files in functions and calls the other functions

Definition at line 293 of file check_parameters.php.

{
       foreach (scandir($path) as $file) {
              if ($file == '.' || $file == '..' || $file == 'CVS') continue;

              $file = "$path/$file";
              if (is_dir($file)) {
                     recurse($file);
                     continue;
              }

              // parse only .c and .cpp files
              if (substr_compare($file, '.c', -2) && substr_compare($file, '.cpp', -4)) continue;

              $txt = file_get_contents($file);
              // remove comments (but preserve the number of lines)
              $txt = preg_replace(array('@//.*@S', '@/\*.*\*/@SsUe'), array('', 'preg_replace("/[^\r\n]+/S", "", \'$0\')'), $txt);


              $split = preg_split('/PHP_(?:NAMED_)?(?:FUNCTION|METHOD)\s*\((\w+(?:,\s*\w+)?)\)/S', $txt, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_OFFSET_CAPTURE);

              if (count($split) < 2) continue; // no functions defined on this file
              array_shift($split); // the first part isn't relevant


              // generate the line offsets array
              $j = 0;
              $lines = preg_split("/(\r\n?|\n)/S", $txt, -1, PREG_SPLIT_DELIM_CAPTURE);
              $lines_offset = array();

              for ($i = 0; $i < count($lines); ++$i) {
                     $j += strlen($lines[$i]) + strlen(@$lines[++$i]);
                     $lines_offset[] = $j;
              }

              $GLOBALS['lines_offset'] = $lines_offset;
              $GLOBALS['current_file'] = $file;


              for ($i = 0; $i < count($split); $i+=2) {
                     // if the /* }}} */ comment is found use it to reduce false positives
                     // TODO: check the other indexes
                     list($f) = preg_split('@/\*\s*}}}\s*\*/@S', $split[$i+1][0]);
                     check_function(preg_replace('/\s*,\s*/S', '::', $split[$i][0]), $f, $split[$i][1]);
              }
       }
}

$dirs = array();

if (isset($argc) && $argc > 1) {
       if ($argv[1] == '-h' || $argv[1] == '-help' || $argv[1] == '--help') {
              echo <<<HELP
Synopsis:
    php check_parameters.php [directories]

HELP;
              exit(0);
       }
       for ($i = 1; $i < $argc; $i++) {
              $dirs[] = $argv[$i];
       }
} else { 
       $dirs[] = PHPDIR;
}

foreach($dirs as $dir) {
       if (is_dir($dir)) {
              if (!is_readable($dir)) {
                     echo "ERROR: directory '", $dir ,"' is not readable\n";
                     exit(1);
              }
       } else {
              echo "ERROR: bogus directory '", $dir ,"'\n";
              exit(1);
       }
}

foreach ($dirs as $dir) {
       recurse(realpath($dir));
}

Here is the call graph for this function:

update_lineno ( offset)

this updates the global var $line (for error reporting)

Definition at line 78 of file check_parameters.php.

{
       global $lines_offset, $line;

       $left  = 0;
       $right = $count = count($lines_offset)-1;

       // a nice binary search :)
       do {
              $mid = intval(($left + $right)/2);
              $val = $lines_offset[$mid];

              if ($val < $offset) {
                     if (++$mid > $count || $lines_offset[$mid] > $offset) {
                            $line = $mid;
                            return;
                     } else {
                            $left = $mid;
                     }
              } else if ($val > $offset) {
                     if ($lines_offset[--$mid] < $offset) {
                            $line = $mid+1;
                            return;
                     } else {
                            $right = $mid;
                     }
              } else {
                     $line = $mid+1;
                     return;
              }
       } while (true);
}

Here is the caller graph for this function:


Variable Documentation

$API_params
Initial value:
 array(
       'a' => array('zval**'), 
       'b' => array('zend_bool*'), 
       'C' => array('zend_class_entry**'), 
       'd' => array('double*'), 
       'f' => array('zend_fcall_info*', 'zend_fcall_info_cache*'), 
       'h' => array('HashTable**'), 
       'l' => array('long*'), 
       'o' => array('zval**'), 
       'O' => array('zval**', 'zend_class_entry*'), 
       'r' => array('zval**'), 
       's' => array('char**', 'int*'), 
       'z' => array('zval**'), 
       'Z' => array('zval***') 
)

Definition at line 35 of file check_parameters.php.

$dirs = array()

Definition at line 341 of file check_parameters.php.

if (isset($argc)&&$argc > 1) else $dirs[] = PHPDIR

Definition at line 356 of file check_parameters.php.