Created an XmlLintTask to validate configuration against XML Schema Definitions and a new target lint-demos to check both syntax of demo configuration and PHP source files

5 files changed, 140 insertions, 6 deletions

diff --git a/.gitattributes b/.gitattributes
index 58690b9d..4f511c4f 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -14,6 +14,7 @@ buildscripts/phing/style/phpunit2-frames.xsl -text
 buildscripts/phing/style/phpunit2-noframes.xsl -text
 buildscripts/phing/style/str.replace.function.xsl -text
 buildscripts/phing/tasks/PhpLintTask.php -text
+buildscripts/phing/tasks/XmlLintTask.php -text
 buildscripts/phpbuilder/build.php -text
 buildscripts/phpbuilder/files.txt -text
 buildscripts/texbuilder/build.php -text
diff --git a/build.xml b/build.xml
index 3fac96b5..e0ea5fd6 100644
--- a/build.xml
+++ b/build.xml
@@ -32,8 +32,11 @@
   <property name="reports.style.dir" value="buildscripts/phing/style"/>
   <property name="reports.geshi.dir" value="${src.dir}/3rdParty/geshi"/>
   <property name="prado.lite" value="pradolite.php"/>
+  <property name="application.xsd" value="${src.dir}/Specs/application.xsd"/>
+  <property name="config.xsd" value="${src.dir}/Specs/config.xsd"/>
 
   <taskdef name="phplint" classname="PhpLintTask" classpath="buildscripts/phing/tasks"/>
+  <taskdef name="xmllint" classname="XmlLintTask" classpath="buildscripts/phing/tasks"/>
 
   <fileset dir="." id="src">
     <exclude name="${src.dir}/**/.svn"/>
@@ -82,6 +85,29 @@
     </phplint>
   </target>
 
+  <target name="lint-demos" description="Check syntax of demo files and configuration files">
+    <echo>Validate application configuration</echo>
+    <xmllint schema="${application.xsd}">
+      <fileset dir="demos">
+        <exclude name="**/.svn"/>
+        <include name="**/application.xml"/>
+      </fileset>
+    </xmllint>
+    <echo>Validate page configuration</echo>
+    <xmllint schema="${config.xsd}">
+      <fileset dir="demos">
+        <exclude name="**/.svn"/>
+        <include name="**/config.xml"/>
+      </fileset>
+    </xmllint>
+    <phplint>
+      <fileset dir="demos">
+        <exclude name="**/.svn"/>
+        <include name="**/*.php"/>
+      </fileset>
+    </phplint>
+  </target>
+
   <target name="prepare" description="Prepare directory layout for build">
     <phingcall target="clean"/>
     <mkdir dir="${build.base.dir}"/>
@@ -157,7 +183,7 @@
     </copy>
   </target>
   
-  <target name="build" depends="versioncheck,prepare,lint,test,doc,pradolite,build-standard-package" description="Creating the main PRADO build">
+  <target name="build" depends="versioncheck,prepare,lint,lint-demos,test,doc,pradolite,build-standard-package" description="Creating the main PRADO build">
   </target>
 
   <target name="dist" depends="build" description="Create PRADO distributions">
diff --git a/buildscripts/phing/tasks/PhpLintTask.php b/buildscripts/phing/tasks/PhpLintTask.php
index 63ae6dde..2fd89fc3 100644
--- a/buildscripts/phing/tasks/PhpLintTask.php
+++ b/buildscripts/phing/tasks/PhpLintTask.php
@@ -34,6 +34,10 @@ class PhpLintTask extends Task {
    * Execute lint check against PhingFile or a FileSet
    */
   public function main() {
+    if(!isset($this->file) and count($this->filesets) == 0) {
+      throw new BuildException("Missing either a nested fileset or attribute 'file' set");
+    }
+
     if($this->file instanceof PhingFile) {
       $this->lint($this->file->getPath());
     } else { // process filesets
@@ -47,7 +51,6 @@ class PhpLintTask extends Task {
 	}
       }
     }
-    $this->log('No syntax errors detected');
   }
 
   /**
@@ -63,7 +66,9 @@ class PhpLintTask extends Task {
 	$message = array();
 	exec($command.$file, $message);
 	if(!preg_match('/^No syntax errors detected/', $message[0])) {
-	  throw new BuildException($message[1]);
+	  $this->log($message[1], PROJECT_MSG_ERR);
+	} else {
+	  $this->log($file.': No syntax errors detected', PROJECT_MSG_INFO);
 	}
       } else {
 	throw new BuildException('Permission denied: '.$file);
diff --git a/buildscripts/phing/tasks/XmlLintTask.php b/buildscripts/phing/tasks/XmlLintTask.php
new file mode 100644
index 00000000..96f58234
--- /dev/null
+++ b/buildscripts/phing/tasks/XmlLintTask.php
@@ -0,0 +1,102 @@
+<?php
+require_once 'phing/Task.php';
+
+/**
+ * A XML lint task. Checking syntax of one or more XML source file against an XML Schema using the DOM extension.
+ *
+ * @author   Knut Urdalen <knut.urdalen@telio.no>
+ * @package  phing.tasks.ext
+ */
+class XmlLintTask extends Task {
+
+  protected $file;  // the source file (from xml attribute)
+  protected $schema; // the schema file (from xml attribute)
+  protected $filesets = array(); // all fileset objects assigned to this task
+
+  /**
+   * File to be performed syntax check on
+   * @param PhingFile $file
+   */
+  public function setFile(PhingFile $file) {
+    $this->file = $file;
+  }
+
+  public function setSchema(PhingFile $schema) {
+    $this->schema = $schema;
+  }
+  
+  /**
+   * Nested creator, creates a FileSet for this task
+   *
+   * @return FileSet The created fileset object
+   */
+  function createFileSet() {
+    $num = array_push($this->filesets, new FileSet());
+    return $this->filesets[$num-1];
+  }
+
+  /**
+   * Execute lint check against PhingFile or a FileSet
+   */
+  public function main() {
+    if(!isset($this->schema)) {
+      throw new BuildException("Missing attribute 'schema'");
+    }
+    $schema = $this->schema->getPath();
+    if(!file_exists($schema)) {
+      throw new BuildException("File not found: ".$schema);
+    }
+    if(!isset($this->file) and count($this->filesets) == 0) {
+      throw new BuildException("Missing either a nested fileset or attribute 'file' set");
+    }
+
+    set_error_handler(array($this, 'errorHandler'));
+    if($this->file instanceof PhingFile) {
+      $this->lint($this->file->getPath());
+    } else { // process filesets
+      $project = $this->getProject();
+      foreach($this->filesets as $fs) {
+	$ds = $fs->getDirectoryScanner($project);
+	$files = $ds->getIncludedFiles();
+	$dir = $fs->getDir($this->project)->getPath();
+	foreach($files as $file) {
+	  $this->lint($dir.DIRECTORY_SEPARATOR.$file);
+	}
+      }
+    }
+    restore_error_handler();
+  }
+
+  /**
+   * Performs validation
+   *
+   * @param string $file
+   * @return void
+   */
+  protected function lint($file) {
+    if(file_exists($file)) {
+      if(is_readable($file)) {
+	$dom = new DOMDocument();
+	$dom->load($file);
+	if($dom->schemaValidate($this->schema->getPath())) {
+	  $this->log($file.' validated', PROJECT_MSG_INFO);
+	} else {
+	  $this->log($file.' fails to validate (See messages above)', PROJECT_MSG_ERR);
+	}
+      } else {
+	throw new BuildException('Permission denied: '.$file);
+      }
+    } else {
+      throw new BuildException('File not found: '.$file);
+    }
+  }
+
+  public function errorHandler($level, $message, $file, $line, $context) {
+    $matches = array();
+    preg_match('/^.*\(\): (.*)$/', $message, $matches);
+    $this->log($matches[1], PROJECT_MSG_ERR);
+  }
+
+}
+
+?>
\ No newline at end of file
diff --git a/demos/quickstart/protected/application.xml b/demos/quickstart/protected/application.xml
index 88cab8d1..743c8ddd 100644
--- a/demos/quickstart/protected/application.xml
+++ b/demos/quickstart/protected/application.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>

 

-<application id="QuickStart" Mode="Debug">

-  <modules>

+<application id="QuickStart" mode="Debug">

+  <!--<modules>-->

     <!-- uncomment the following to enable caching

     <module id="cache" class="System.Data.TSqliteCache" />

     -->

@@ -10,7 +10,7 @@
       <route class="TFileLogRoute" />

     </module>

     -->

-  </modules>

+  <!--</modules>-->

   <paths>

     <using namespace="Application.controls.*" />

   </paths>