<?php
namespace PHPCheckstyle\Config;
/**
* Loads the test configuration.
*
* @author Hari Kodungallur <hkodungallur@spikesource.com>
*/
class CheckXMLStyleConfig extends CheckStyleConfig {
// The configuration file
private $file;
// Array that contains the loaded checks configuration
public $myConfig = array();
private $currentTest = false;
private $currentConfig = false;
private $xmlParser;
/**
* Constructor.
*
* @param String $configFile
* The path of the config file
*/
public function __construct($configFile) {
// If the path is a valid file we use it as is
if (is_file($configFile)) {
$this->file = $configFile;
} else {
// Otherwise we look in the config directory
$this->file = PHPCHECKSTYLE_HOME_DIR . "/config/" . $configFile;
if (!is_file($this->file)) {
echo "Config file not found : " . $configFile;
exit(0);
}
}
$this->xmlParser = xml_parser_create();
xml_set_object($this->xmlParser, $this);
xml_set_element_handler($this->xmlParser, "_startElement", "_endElement");
xml_set_character_data_handler($this->xmlParser, "_gotCdata");
xml_set_default_handler($this->xmlParser, "_gotCdata");
}
/**
* Destructor.
*/
public function __destruct() {
if ($this->xmlParser !== null) {
xml_parser_free($this->xmlParser);
}
}
/**
* Parses the configuration file and stores the values.
*
* @throws Exception if cannot access file
*/
public function parse() {
$fp = fopen($this->file, "r");
if (!$fp) {
throw new Exception("Could not open XML input file");
}
$data = fread($fp, 4096);
while ($data) {
if (!xml_parse($this->xmlParser, $data, feof($fp))) {
$msg = sprintf("Warning: XML error: %s at line %d", xml_error_string(xml_get_error_code($this->xmlParser)), xml_get_current_line_number($this->xmlParser));
echo $msg;
$this->myConfig = array();
}
$data = fread($fp, 4096);
}
}
/**
* Return a list of items associed with a test.
*
* @param String $test
* name of the test
* @return array the list of items for this test.
*/
public function getTestItems($test) {
$test = strtolower($test);
return isset($this->myConfig[$test]['item']) ? $this->myConfig[$test]['item'] : false;
}
/**
* Return a list of items associed with a configuration.
*
* @param String $config
* name of the config
* @return array the list of items for this config.
*/
public function getConfigItems($config) {
return $this->myConfig[strtolower($config)];
}
/**
* Return a list of exceptionfor a test.
*
* @param String $test
* name of the test
* @return array the list of exceptions for this test.
*/
public function getTestExceptions($test) {
$test = strtolower($test);
return isset($this->myConfig[$test]['exception']) ? $this->myConfig[$test]['exception'] : false;
}
/**
* Return a true if the test exist, false otherwise.
*
* @param String $test
* name of the test
* @return Boolean true if test exists.
*/
public function getTest($test) {
$test = strtolower($test);
return (array_key_exists($test, $this->myConfig));
}
/**
* Return the level of severity of a test.
*
* @param String $test
* name of the test
* @return the level of severity.
*/
public function getTestLevel($test) {
$test = strtolower($test);
$ret = WARNING;
if (array_key_exists($test, $this->myConfig) && array_key_exists('level', $this->myConfig[$test])) {
$ret = $this->myConfig[$test]['level'];
}
if ($ret != ERROR && $ret != IGNORE && $ret != INFO && $ret != WARNING) {
echo "Invalid level for test " . $test . " : " . $ret;
$ret = WARNING;
}
return $ret;
}
/**
* Return the regular expression linked to the test.
*
* @param String $test
* name of the test
* @return the regular expression.
*/
public function getTestRegExp($test) {
$test = strtolower($test);
$ret = "";
if (array_key_exists($test, $this->myConfig) && array_key_exists('regexp', $this->myConfig[$test])) {
$ret = $this->myConfig[$test]['regexp'];
}
return $ret;
}
/**
* Return the list of deprecated method and their replacement.
*
* @param String $test
* name of the test
* @return the list of depecated values.
*/
public function getTestDeprecations($test) {
$test = strtolower($test);
$ret = "";
if (array_key_exists($test, $this->myConfig)) {
$ret = $this->myConfig[$test];
}
return $ret;
}
/**
* Return the list of aliases and their replacement.
*
* @param String $test
* name of the test
* @return the list of replaced values.
*/
public function getTestAliases($test) {
$test = strtolower($test);
$ret = "";
if (array_key_exists($test, $this->myConfig)) {
$ret = $this->myConfig[$test];
}
return $ret;
}
/**
* Return the list of replacements.
*
* @param String $test
* name of the test
* @return the list of replaced values.
*/
public function getTestReplacements($test) {
$test = strtolower($test);
$ret = "";
if (array_key_exists($test, $this->myConfig)) {
$ret = $this->myConfig[$test];
}
return $ret;
}
/**
* Return the value of a property
*
* @param String $test
* name of the test
* @param String $property
* name of the property
* @return the value.
*/
public function getTestProperty($test, $property) {
$test = strtolower($test);
$property = strtolower($property);
if (array_key_exists($test, $this->myConfig) && array_key_exists($property, $this->myConfig[$test])) {
return $this->myConfig[$test][$property];
} else {
return false;
}
}
/**
* SAX function indicating start of an element
* Store the TEST and PROPERTY values in an array
*
* @param Parser $parser
* the parser
* @param Elem $elem
* name of element
* @param Attributes $attrs
* list of attributes of the element
*/
private function _startElement($parser, $elem, $attrs) {
switch ($elem) {
// Case of a configuration property
case 'CONFIG':
$this->currentConfig = strtolower($attrs['NAME']);
$this->myConfig[$this->currentConfig] = array();
break;
// Case of a configuration property item
case 'CONFIGITEM':
$this->myConfig[$this->currentConfig][] = $attrs['VALUE'];
break;
// Case of a test rule
case 'TEST':
$this->currentTest = strtolower($attrs['NAME']);
$this->myConfig[$this->currentTest] = array();
if (isset($attrs['LEVEL'])) {
$this->myConfig[$this->currentTest]['level'] = $attrs['LEVEL'];
}
if (isset($attrs['REGEXP'])) {
$this->myConfig[$this->currentTest]['regexp'] = $attrs['REGEXP'];
}
break;
// Case of a propertie of a rule (name / value)
case 'PROPERTY':
$pname = $attrs['NAME'];
$pval = true;
if (array_key_exists('VALUE', $attrs)) {
$pval = $attrs['VALUE'];
}
$this->myConfig[$this->currentTest][strtolower($pname)] = $pval;
break;
// Case of a item of a list of values of a rule
case 'ITEM':
if (isset($attrs['VALUE'])) {
$this->myConfig[$this->currentTest]['item'][] = $attrs['VALUE'];
}
break;
// Case of an exception to a rule
case 'EXCEPTION':
if (isset($attrs['VALUE'])) {
$this->myConfig[$this->currentTest]['exception'][] = $attrs['VALUE'];
}
break;
// Case of a deprecated function
case 'DEPRECATED':
if (isset($attrs['OLD'])) {
$this->myConfig[$this->currentTest][strtolower($attrs['OLD'])]['old'] = $attrs['OLD'];
}
if (isset($attrs['NEW'])) {
$this->myConfig[$this->currentTest][strtolower($attrs['OLD'])]['new'] = $attrs['NEW'];
}
if (isset($attrs['VERSION'])) {
$this->myConfig[$this->currentTest][strtolower($attrs['OLD'])]['version'] = $attrs['VERSION'];
}
break;
// Case of an alias function
case 'ALIAS':
if (isset($attrs['OLD'])) {
$this->myConfig[$this->currentTest][strtolower($attrs['OLD'])]['old'] = $attrs['OLD'];
}
if (isset($attrs['NEW'])) {
$this->myConfig[$this->currentTest][strtolower($attrs['OLD'])]['new'] = $attrs['NEW'];
}
break;
// Case of a replacement
case 'REPLACEMENT':
if (isset($attrs['OLD'])) {
$this->myConfig[$this->currentTest][strtolower($attrs['OLD'])]['old'] = $attrs['OLD'];
}
if (isset($attrs['NEW'])) {
$this->myConfig[$this->currentTest][strtolower($attrs['OLD'])]['new'] = $attrs['NEW'];
}
break;
default:
break;
}
}
/**
* SAX function indicating end of element
* Currenlty we dont need to do anything here
*
* @param Parser $parser
* @param String $name
*/
private function _endElement($parser, $name) {}
/**
* SAX function for processing CDATA
* Currenlty we dont need to do anything here
*
* @param Parser $parser
* @param String $name
*/
private function _gotCdata($parser, $name) {}
}
