Changeset 1920

Timestamp:

05/10/07 14:52:23 (20 months ago)

Author:

david

Message:

initial support for native xml config handlers. config validation much more flexible now, added internal support for xml schema, relaxng and (dummy) schematron. all the old stuff still works and always will (or, well, at least until 1.1 or so). more to come. refs #519

Location:

branches/david-xml_config_handlers/src

Files:

• config/AgaviConfigCache.class.php (modified) (7 diffs)
• config/AgaviConfigHandlersConfigHandler.class.php (modified) (1 diff)
• config/AgaviConfigParser.class.php (modified) (2 diffs)
• config/AgaviXmlConfigHandler.class.php (modified) (1 diff)
• config/AgaviXmlConfigParser.class.php (modified) (12 diffs)
• core/Agavi.class.php (modified) (1 diff)

branches/david-xml_config_handlers/src/config/AgaviConfigCache.class.php

@@ -56 +56 @@
    * @since      0.9.0
    */
-  private static function callHandler($handler, $config, $cache, $context)
-  {
-
+  private static function callHandler($name, $config, $cache, $context)
+  {
     if(self::$handlers === null) {
       // we need to load the handlers first
@@ -64 +63 @@
       self::loadConfigHandlers();
     }
-
+    
     // grab the base name of the handler
-    $basename = basename($handler);
-
-    if(isset(self::$handlers[$handler])) {
+    $basename = basename($name);
+    
+    $handlerInfo = null;
+    
+    if(isset(self::$handlers[$name])) {
       // we have a handler associated with the full configuration path
-      // call the handler and retrieve the cache data
-      $data = self::$handlers[$handler]->execute($config, $context);
-      self::writeCacheFile($config, $cache, $data, false);
-      return;
+      $handlerInfo = self::$handlers[$name];
     } elseif(isset(self::$handlers[$basename])) {
       // we have a handler associated with the configuration base name
-      // call the handler and retrieve the cache data
-      $data = self::$handlers[$basename]->execute($config, $context);
-      self::writeCacheFile($config, $cache, $data, false);
-      return;
+      $handlerInfo = self::$handlers[$basename];
     } else {
       // let's see if we have any wildcard handlers registered that match
       // this basename
-      foreach(self::$handlers as $key => $handlerInstance)  {
+      foreach(self::$handlers as $key => $value)  {
         // replace wildcard chars in the configuration and create the pattern
         $pattern = sprintf('#%s#', str_replace('\*', '.*?', preg_quote($key)));
-
-        if(preg_match($pattern, $handler)) {
-          // call the handler and retrieve the cache data
-          $data = $handlerInstance->execute($config, $context);
-          self::writeCacheFile($config, $cache, $data, false);
-          return;
+        
+        if(preg_match($pattern, $name)) {
+          $handlerInfo = $value;
+          break;
         }
       }
     }
-
-    // we do not have a registered handler for this file
-    $error = 'Configuration file "%s" does not have a registered handler';
-    $error = sprintf($error, $config);
-    throw new AgaviConfigurationException($error);
+    
+    if($handlerInfo === null) {
+      // we do not have a registered handler for this file
+      $error = 'Configuration file "%s" does not have a registered handler';
+      $error = sprintf($error, $config);
+      throw new AgaviConfigurationException($error);
+    }
+    
+    // call the handler and retrieve the cache data
+    $handler = new $handlerInfo['class'];
+    if($handler instanceof AgaviIXmlConfigHandler) {
+      
+    } else {
+      if(isset($handlerInfo['validation']))
+      $handler->initialize($handlerInfo['validation'], null, $handlerInfo['parameters']);
+    }
+    
+    $data = $handler->execute($config, $context);
+    self::writeCacheFile($config, $cache, $data, false);
   }
 
@@ -141 +148 @@
 
     return $cache;
-
   }
 
@@ -234 +240 @@
     // since we only need the parser and handlers when the config is not cached
     // it is sufficient to include them at this stage
+    require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviBaseConfigHandler.class.php');
+    require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviConfigHandler.class.php');
+    require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviIXmlConfigHandler.class.php');
+    require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviXmlConfigHandler.class.php');
+    require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviAutoloadConfigHandler.class.php');
     require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviConfigHandlersConfigHandler.class.php');
     require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviConfigValueHolder.class.php');
@@ -240 +251 @@
 
     // manually create our config_handlers.xml handler
-    self::$handlers['config_handlers.xml'] = new AgaviConfigHandlersConfigHandler();
-    self::$handlers['config_handlers.xml']->initialize(AgaviConfig::get('core.agavi_dir') . '/config/xsd/config_handlers.xsd');
+    self::$handlers['config_handlers.xml'] = array(
+      'class' => 'AgaviConfigHandlersConfigHandler', 
+      'parameters' => array(
+      ),
+      'validation' => array(
+        AgaviXmlConfigParser::VALIDATION_TYPE_XMLSCHEMA => array(
+          AgaviConfig::get('core.agavi_dir') . '/config/xsd/config_handlers.xsd',
+        ),
+      ),
+    );
 
     $cfg = AgaviConfig::get('core.config_dir') . '/config_handlers.xml';
@@ -303 +322 @@
    *             extension couldn't be found.
    *
+   * @deprecated New-style config handlers don't call this method anymore.
+   *
    * @author     Dominik del Bondio <ddb@bitxtender.com>
    * @author     David Zülke <dz@bitxtender.com>
@@ -309 +330 @@
   public static function parseConfig($config, $autoloadParser = true, $validateFile = null, $parserClass = null)
   {
-    $parser = new AgaviXmlConfigParser();
-    
-    return $parsers->parse($config, $validateFile);
-  }
-
+    $parser = new AgaviConfigParser();
+    
+    return $parser->parse($config, $validateFile);
+  }
 }
 

branches/david-xml_config_handlers/src/config/AgaviConfigHandlersConfigHandler.class.php

@@ -53 +53 @@
     // parse the config file
     $configurations = $this->orderConfigurations(AgaviConfigCache::parseConfig($config, false, $this->getValidationFile(), $this->parser)->configurations, AgaviConfig::get('core.environment'));
-
+    
     // init our data arrays
-    $data     = array();
-
+    $data = array();
+    
     foreach($configurations as $cfg) {
       // let's do our fancy work
       foreach($cfg->handlers as $handler) {
         $pattern = $handler->getAttribute('pattern');
-
+        
         $category = var_export(AgaviToolkit::normalizePath($this->replaceConstants($pattern)), true);
-
-        $class = $handler->getAttribute('class');
-
-        $parameters = $this->getItemParameters($handler);
-
+        
+        $class = var_export($handler->getAttribute('class'), true);
+        
+        $validation = array(
+          AgaviXmlConfigParser::VALIDATION_TYPE_RELAXNG    => array(
+          ),
+          AgaviXmlConfigParser::VALIDATION_TYPE_SCHEMATRON => array(
+          ),
+          AgaviXmlConfigParser::VALIDATION_TYPE_XMLSCHEMA  => array(
+          ),
+        );
+        if($handler->hasAttribute('validate')) {
+          $validation[AgaviXmlConfigParser::VALIDATION_TYPE_XMLSCHEMA][] = $this->literalize($handler->getAttribute('validate'));
+        } elseif(false) {
+          // TODO: check for <validations><validation type="schematron"> children here
+        }
+        $validation = var_export($validation, true);
+        
+        $parameters = var_export($this->getItemParameters($handler), true);
+        
         // append new data
-        $tmp    = "self::\$handlers[%s] = new %s();";
-        $data[] = sprintf($tmp, $category, $class);
-
-        $tmp    = "self::\$handlers[%s]->initialize(%s, %s, %s);";
-        $data[] = sprintf($tmp, $category, var_export($this->literalize($handler->getAttribute('validate')), true), var_export($handler->getAttribute('parser'), true), var_export($parameters, true));
+        $tmp    = "self::\$handlers[%s] = array('class' => %s, 'parameters' => %s, 'validation' => %s);";
+        $data[] = sprintf($tmp, $category, $class, $parameters, $validation);
       }
     }

branches/david-xml_config_handlers/src/config/AgaviConfigParser.class.php

@@ -16 +16 @@
 
 /**
- * AgaviConfigHandler allows a developer to create a custom formatted 
- * configuration file format.
+ * AgaviConfigParser parses XML files using AgaviXmlConfigParser, but returns
+ * old-style ConfigValueHolders.
  *
  * @package    agavi
  * @subpackage config
  *
- * @author     Dominik del Bondio <ddb@bitxtender.com>
+ * @author     David Zülke <dz@bitxtender.com>
  * @copyright  Authors
  * @copyright  The Agavi Project
+ *
+ * @deprecated Superseded by AgaviXmlConfigParser
  *
  * @since      0.11.0
@@ -30 +32 @@
  * @version    $Id$
  */
-abstract class AgaviConfigParser
+class AgaviConfigParser
 {
   /**
-   * Execute this configuration parser.
+   * @var        string The encoding of the DOMDocument
+   */
+  protected $encoding = 'utf-8';
+  
+  /**
+   * @param      string An absolute filesystem path to a configuration file.
+   * @param      array  An associative array of validation information.
    *
-   * @param      string An absolute filesystem path to a configuration file.
+   * @return     AgaviConfigValueHolder The data handlers use to perform tasks.
    *
-   * @return     AgaviConfigValueHolder Data to be written to a cache file.
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function parse($config, array $validationInfo = array())
+  {
+    $parser = new AgaviXmlConfigParser();
+    
+    $doc = $parser->parse($config, $validationInfo);
+    
+    $this->encoding = $doc->encoding;
+    
+    $rootRes = new AgaviConfigValueHolder();
+    
+    if($doc->documentElement) {
+      $this->parseNodes(array($doc->documentElement), $rootRes);
+    }
+    
+    return $rootRes;
+  }
+
+  /**
+   * Iterates thru a list of nodes and stores to each node in the
+   * ConfigValueHolder
    *
-   * @throws     <b>AgaviUnreadableException</b> If a requested configuration
-   *                                             file does not exist or is not
-   *                                             readable.
-   * @throws     <b>AgaviParseException</b>      If a requested configuration
-   *                                             file is improperly formatted.
+   * @param      mixed An array or an object that can be iterated over
+   * @param      AgaviXmlValueHolder The storage for the info from the nodes
+   * @param      bool Whether this list is the singular form of the parent node
    *
+   * @author     David Zülke <dz@bitxtender.com>
    * @author     Dominik del Bondio <ddb@bitxtender.com>
    * @since      0.11.0
    */
-  public abstract function parse($config);
+  protected function parseNodes($nodes, AgaviConfigValueHolder $parentVh, $isSingular = false)
+  {
+    foreach($nodes as $node) {
+      if($node->nodeType == XML_ELEMENT_NODE && (!$node->namespaceURI || $node->namespaceURI == AgaviXmlConfigParser::XML_NAMESPACE)) {
+        $vh = new AgaviConfigValueHolder();
+        $nodeName = $this->convertEncoding($node->localName);
+        $vh->setName($nodeName);
+        $parentVh->addChildren($nodeName, $vh);
 
+        foreach($node->attributes as $attribute) {
+          if((!$attribute->namespaceURI || $attribute->namespaceURI == AgaviXmlConfigParser::XML_NAMESPACE)) {
+            $vh->setAttribute($this->convertEncoding($attribute->localName), $this->convertEncoding($attribute->nodeValue));
+          }
+        }
+
+        // there are no child nodes so we set the node text contents as the value for the valueholder
+        if($node->getElementsByTagName('*')->length == 0) {
+          $vh->setValue($this->convertEncoding($node->nodeValue));
+        }
+
+        if($node->hasChildNodes()) {
+          $this->parseNodes($node->childNodes, $vh);
+        }
+      }
+    }
+  }
+  
+  /**
+   * Handle encoding for a value, i.e. translate from UTF-8 if necessary.
+   *
+   * @param      string A UTF-8 string value from the DomDocument.
+   *
+   * @return     string A value in the correct encoding of the parsed document.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  protected function convertEncoding($value)
+  {
+    if($this->encoding == 'utf-8') {
+      return $value;
+    } elseif($this->encoding == 'iso-8859-1') {
+      return utf8_decode($value);
+    } elseif(function_exists('iconv')) {
+      return iconv('UTF-8', $this->encoding, $value);
+    } else {
+      throw new AgaviParseException('No iconv module available, configuration file "' . $this->config . '" with input encoding "' . $this->encoding . '" cannot be parsed.');
+    }
+  }
 }
 

branches/david-xml_config_handlers/src/config/AgaviXmlConfigHandler.class.php

@@ -30 +30 @@
 class AgaviXmlConfigHandler extends AgaviBaseConfigHandler implements AgaviIXmlConfigHandler
 {
+  public function execute($config, $context = null)
+  {
+  }
 }

branches/david-xml_config_handlers/src/config/AgaviXmlConfigParser.class.php

@@ -29 +29 @@
  * @version    $Id$
  */
-
 class AgaviXmlConfigParser extends AgaviConfigParser
 {
   const XML_NAMESPACE = 'http://agavi.org/agavi/1.0/config';
   
-  /**
-   * @var        DomXPath A DomXPath instance used to parse this document.
-   */
-  protected $xpath = null;
-  
-  /**
-   * @var        string The encoding of the file that's being parsed here.
-   */
-  protected $encoding = 'utf-8';
-  
-  /**
-   * @var        string The name of the config file we're parsing.
-   */
-  protected $config = '';
-
-  /**
-   * @see        AgaviConfigParser::parse()
+  const VALIDATION_TYPE_XMLSCHEMA = 'xml_schema';
+  
+  const VALIDATION_TYPE_RELAXNG = 'relax_ng';
+  
+  const VALIDATION_TYPE_SCHEMATRON = 'schematron';
+  
+  /**
+   * @param      string An absolute filesystem path to a configuration file.
+   * @param      array  An associative array of validation information.
+   *
+   * @return     array An array of DOMDocuments (from child to parent).
    *
    * @author     David Zülke <dz@bitxtender.com>
@@ -56 +49 @@
    * @since      0.11.0
    */
-  public function parse($config, $validationFile = null)
+  public function parse($config, array $validation = array())
   {
     if(!is_readable($config)) {
@@ -63 +56 @@
     }
     
-    $doc = $this->loadAndTransform($config, $validationFile = null);
-    
-    $rootRes = new AgaviConfigValueHolder();
-    
-    if($doc->documentElement) {
-      $this->parseNodes(array($doc->documentElement), $rootRes);
-    }
-    
-    return $rootRes;
-  }
-  
-  /**
-   * Load the file into DOM, resolve XIncludes, apply XSL, validate against XSD.
-   *
-   * @param      string The path to the XML file
-   * @param      string The path to the validation file.
-   *
-   * @return     DOMDocument The fully loaded and transformed DOM document.
-   *
-   * @author     David Zülke <dz@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function loadAndTransform($config, $validationFile = null)
-  {
-    $this->config = $config;
-    
+    $doc = $this->load($config);
+    
+    $this->transform($doc);
+    
+    $this->validate($doc, $validation);
+    
+    $this->cleanup($doc);
+    
+    return $doc;
+  }
+  
+  /**
+   * Create and return a DOMXPath object for the document.
+   *
+   * @param      DOMDocument The document to create the DOMXPath object for.
+   * @param      bool        If the XML namespace from the document element
+   *                         should be registered as 'agavi'.
+   *
+   * @return     DOMXPath A DOMXPath instance for the document.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function createXpath(DOMDocument $doc, $registerNamespace = true)
+  {
+    $xpath = new DOMXPath($doc);
+    
+    if($registerNamespace && $doc->documentElement) {
+      $xpath->registerNamespace('agavi', $doc->documentElement->namespaceURI);
+    }
+    
+    return $xpath;
+  }
+  
+  /**
+   * Load the configuration file into DOM and resolve XIncludes.
+   *
+   * @param      string The path to the configuration file.
+   *
+   * @return     DOMDocument The loaded document.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function load($config)
+  {
     $luie = libxml_use_internal_errors(true);
     libxml_clear_errors();
@@ -110 +123 @@
     }
     
-    $this->encoding = strtolower($doc->encoding);
-    
     // replace %lala% directives in XInclude href attributes
     foreach($doc->getElementsByTagNameNS('http://www.w3.org/2001/XInclude', '*') as $element) {
@@ -156 +167 @@
     }
     
-    $this->xpath = new DOMXPath($doc);
-    
-    $stylesheetProcessingInstructions = $this->xpath->query("//processing-instruction('xml-stylesheet')", $doc);
+    libxml_use_internal_errors($luie);
+    
+    return $doc;
+  }
+  
+  /**
+   * Transform the document using info from embedded processing instructions.
+   *
+   * @param      DOMDocument The document to transform.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function transform(DOMDocument $doc)
+  {
+    $luie = libxml_use_internal_errors(true);
+    
+    $xpath = $this->createXpath($doc, false);
+    
+    $stylesheetProcessingInstructions = $xpath->query("//processing-instruction('xml-stylesheet')", $doc);
     foreach($stylesheetProcessingInstructions as $pi) {
       $fragment = $doc->createDocumentFragment();
@@ -168 +196 @@
         if(strpos($href, '#') === 0) {
           // embedded XSL
-          $stylesheets = $this->xpath->query("//*[@id='" . substr($href, 1) . "']", $doc);
+          $stylesheets = $xpath->query("//*[@id='" . substr($href, 1) . "']", $doc);
           if($stylesheets->length) {
             $xsl = new DomDocument();
@@ -220 +248 @@
           }
         }
-
+        
         $proc = new XSLTProcessor();
         $proc->importStylesheet($xsl);
@@ -242 +270 @@
           );
         }
-
-        $this->xpath = null;
+        
+        unset($xpath);
         
         $newdoc = $proc->transformToDoc($doc);
@@ -264 +292 @@
           );
         }
-
+        
         if($newdoc) {
           $doc = $newdoc;
         }
         
-        $this->xpath = new DOMXPath($doc);
-        
         $pi->parentNode->removeChild($pi);
         
@@ -277 +303 @@
     }
     
-    if($doc->documentElement) {
-      $this->xpath->registerNamespace('agavi', $doc->documentElement->namespaceURI);
-    
-      // remove top-level <sandbox> elements
-      $sandboxes = $this->xpath->query('/agavi:configurations/agavi:sandbox', $doc);
-      foreach($sandboxes as $sandbox) {
-        $sandbox->parentNode->removeChild($sandbox);
-      }
-    }
-    
-    if($validationFile) {
+    libxml_use_internal_errors($luie);
+  }
+  
+  /**
+   * Load the file into DOM, resolve XIncludes, apply XSL, validate against XSD.
+   *
+   * @param      string The path to the XML file
+   * @param      string The path to the validation file.
+   *
+   * @return     DOMDocument The fully loaded and transformed DOM document.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function validate(DOMDocument $doc, array $validationInfo = array())
+  {
+    foreach($validationInfo as $type => $files) {
+      switch($type) {
+        case self::VALIDATION_TYPE_XMLSCHEMA:
+          $this->validateXmlschema($doc, (array) $files);
+          break;
+        case self::VALIDATION_TYPE_RELAXNG:
+          $this->validateRelaxng($doc, (array) $files);
+          break;
+        case self::VALIDATION_TYPE_SCHEMATRON:
+          $this->validateSchematron($doc, (array) $files);
+          break;
+      }
+    }
+  }
+  
+  /**
+   * Clean up the document.
+   *
+   * @param      DOMDocument The document to clean up.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function cleanup(DOMDocument $doc)
+  {
+    $xpath = $this->createXpath($doc);
+    
+    // remove top-level <sandbox> elements
+    $sandboxes = $xpath->query('/agavi:configurations/agavi:sandbox', $doc);
+    foreach($sandboxes as $sandbox) {
+      $sandbox->parentNode->removeChild($sandbox);
+    }
+    
+    unset($xpath);
+  }
+  
+  /**
+   * Validate the document against the given list of XML Schema files.
+   *
+   * @param      DOMDocument The document to validate.
+   * @param      array       An array of file names to validate.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function validateXmlschema(DOMDocument $doc, array $validationFiles = array())
+  {
+    $luie = libxml_use_internal_errors(true);
+    
+    foreach($validationFiles as $validationFile) {
       if(!is_readable($validationFile)) {
         libxml_use_internal_errors($luie);
@@ -293 +374 @@
         throw new AgaviUnreadableException($error);
       }
+      
       if(!$doc->schemaValidate($validationFile)) {
         $errors = array();
@@ -312 +394 @@
     
     libxml_use_internal_errors($luie);
-    
-    return $doc;
-  }
+  }
+  
+  /**
+   * Validate the document against the given list of RELAX NG files.
+   *
+   * @param      DOMDocument The document to validate.
+   * @param      array       An array of file names to validate.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function validateRelaxng(DOMDocument $doc, array $validationFiles = array())
+  {
+    $luie = libxml_use_internal_errors(true);
+    
+    foreach($validationFiles as $validationFile) {
+      if(!is_readable($validationFile)) {
+        libxml_use_internal_errors($luie);
+        $error = 'Validation file "' . $validationFile . '" for configuration file "' . $config . '" does not exist or is unreadable';
+        throw new AgaviUnreadableException($error);
+      }
+      
+      if(!$doc->relaxNGValidate($validationFile)) {