Changeset 2632

Timestamp:

07/31/08 14:59:32 (5 months ago)

Author:

impl

Message:

branches/david-xml_only_config_system (refs #519): Add new namespaces for 1.0; introduce RelaxNG validation for factories.xml; implement parts of AgaviXmlConfig?(DomElement?|DomDocument?); implement the factories XML config handler; bugfixes

Location:

branches/david-xml_only_config_system

Files:

• samples/app/config/config_handlers.xml (modified) (1 diff)
• src/config/AgaviBaseConfigHandler.class.php (modified) (1 diff)
• src/config/AgaviConfigHandler.class.php (modified) (1 diff)
• src/config/AgaviConfigHandlersConfigHandler.class.php (modified) (1 diff)
• src/config/AgaviConfigParser.class.php (modified) (2 diffs)
• src/config/AgaviXmlConfigParser.class.php (modified) (5 diffs)
• src/config/AgaviXmlFactoryConfigHandler.class.php (modified) (3 diffs)
• src/config/rng/_common.rng (added)
• src/config/rng/factories.rng (added)
• src/config/util/dom/AgaviXmlConfigDomDocument.class.php (modified) (2 diffs)
• src/config/util/dom/AgaviXmlConfigDomElement.class.php (modified) (4 diffs)
• src/config/util/xsl/AgaviXmlConfigXsltProcessor.class.php (modified) (1 diff)
• src/config/xsl/_common.xsl (modified) (1 diff)
• src/config/xsl/factories.xsl (modified) (3 diffs)

branches/david-xml_only_config_system/samples/app/config/config_handlers.xml

@@ -4 +4 @@
   <configuration>
     
-    <!-- <handler pattern="%core.config_dir%/factories.xml" class="AgaviXmlFactoryConfigHandler" validate="%core.agavi_dir%/config/xsd/factories.xsd">
-      <validation>%core.agavi_dir%/config/xsd/factories.xsd</validation>
-      <validation>%core.agavi_dir%/config/sch/config_handlers.sch</validation>
+    <handler pattern="%core.config_dir%/factories.xml" class="AgaviXmlFactoryConfigHandler">
+      <validation>%core.agavi_dir%/config/rng/factories.rng</validation>
+      <!-- <validation>%core.agavi_dir%/config/sch/config_handlers.sch</validation> -->
       <transformation>%core.agavi_dir%/config/xsl/factories.xsl</transformation>
-    </handler> -->
+    </handler>
     
   </configuration>

branches/david-xml_only_config_system/src/config/AgaviBaseConfigHandler.class.php

@@ -35 +35 @@
 abstract class AgaviBaseConfigHandler extends AgaviParameterHolder
 {
-  /**
-   * Retrieve the parameter node values of the given item's parameters element.
-   *
-   * @param      ConfigValueHolder The node that contains a parameters chiild.
-   * @param      array             As associative array of parameters that will
-   *                               be overwritten if appropriate.
-   * @param      boolean           Whether or not values should be literalized.
-   *
-   * @return     array An associative array of parameters
-   *
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.11.0
-   */
-  protected function getItemParameters($itemNode, $oldValues = array(), $literalize = true)
-  {
-    $data = array();
-    if($itemNode->hasChildren('parameters')) {
-      foreach($itemNode->parameters as $node) {
-        if(!$node->hasAttribute('name')) {
-          // create a new entry in in the array and get they key of the new
-          // created entry (the last in the array). The value doesn't matter
-          // since it will be overwritten anyways
-          $data[] = 0;
-          end($data);
-          $name = key($data);
-        } else {
-          $name = $node->getAttribute('name');
-        }
-        if($node->hasChildren('parameters')) {
-          $data[$name] = (isset($oldValues[$name]) && is_array($oldValues[$name])) ? $oldValues[$name] : array();
-          $data[$name] = $this->getItemParameters($node, $data[$name], $literalize);
-        } else {
-          $data[$name] = $literalize ? AgaviToolkit::literalize($node->getValue()) : $node->getValue();
-        }
-      }
-    }
-    // we can NOT use array_merge here, since it would break numeric keys
-    foreach($data as $key => $value) {
-      $oldValues[$key] = $value;
-    }
-    return $oldValues;
-  }
-
   /**
    * Generate the code for returning from execute().

branches/david-xml_only_config_system/src/config/AgaviConfigHandler.class.php

@@ -47 +47 @@
    */
   protected $parser = null;
+  
+  /**
+   * Retrieve the parameter node values of the given item's parameters element.
+   *
+   * @param      ConfigValueHolder The node that contains a parameters chiild.
+   * @param      array             As associative array of parameters that will
+   *                               be overwritten if appropriate.
+   * @param      boolean           Whether or not values should be literalized.
+   *
+   * @return     array An associative array of parameters
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.11.0
+   */
+  protected function getItemParameters($itemNode, $oldValues = array(), $literalize = true)
+  {
+    $data = array();
+    if($itemNode->hasChildren('parameters')) {
+      foreach($itemNode->parameters as $node) {
+        if(!$node->hasAttribute('name')) {
+          // create a new entry in in the array and get they key of the new
+          // created entry (the last in the array). The value doesn't matter
+          // since it will be overwritten anyways
+          $data[] = 0;
+          end($data);
+          $name = key($data);
+        } else {
+          $name = $node->getAttribute('name');
+        }
+        if($node->hasChildren('parameters')) {
+          $data[$name] = (isset($oldValues[$name]) && is_array($oldValues[$name])) ? $oldValues[$name] : array();
+          $data[$name] = $this->getItemParameters($node, $data[$name], $literalize);
+        } else {
+          $data[$name] = $literalize ? AgaviToolkit::literalize($node->getValue()) : $node->getValue();
+        }
+      }
+    }
+    // we can NOT use array_merge here, since it would break numeric keys
+    foreach($data as $key => $value) {
+      $oldValues[$key] = $value;
+    }
+    return $oldValues;
+  }
 
   /**

branches/david-xml_only_config_system/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
     $handlers = array();

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

@@ -84 +84 @@
   {
     foreach($nodes as $node) {
-      if($node->nodeType == XML_ELEMENT_NODE && (!$node->namespaceURI || $node->namespaceURI == AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_1_0)) {
+      if($node->nodeType == XML_ELEMENT_NODE && (!$node->namespaceURI || $node->namespaceURI == AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_0_11)) {
         $vh = new AgaviConfigValueHolder();
         $nodeName = $this->convertEncoding($node->localName);
@@ -91 +91 @@
 
         foreach($node->attributes as $attribute) {
-          if((!$attribute->namespaceURI || $attribute->namespaceURI == AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_1_0)) {
+          if((!$attribute->namespaceURI || $attribute->namespaceURI == AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_0_11)) {
             $vh->setAttribute($this->convertEncoding($attribute->localName), $this->convertEncoding($attribute->nodeValue));
           }

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

@@ -32 +32 @@
 class AgaviXmlConfigParser
 {
-  const AGAVI_ENVELOPE_NAMESPACE_1_0 = 'http://agavi.org/agavi/1.0/config';
+  const AGAVI_ENVELOPE_NAMESPACE_0_11 = 'http://agavi.org/agavi/1.0/config';
+  
+  const AGAVI_ENVELOPE_NAMESPACE_1_0 = 'http://agavi.org/agavi/config/1.0';
   
   const AGAVI_ENVELOPE_NAMESPACE_LATEST = self::AGAVI_ENVELOPE_NAMESPACE_1_0;
@@ -53 +55 @@
    */
   public static $agaviEnvelopeNamespaces = array(
+    self::AGAVI_ENVELOPE_NAMESPACE_0_11 => 'agavi_envelope_0_11',
     self::AGAVI_ENVELOPE_NAMESPACE_1_0 => 'agavi_envelope_1_0',
   );
@@ -104 +107 @@
   {
     return isset(self::$agaviEnvelopeNamespaces[$namespaceUri]);
+  }
+  
+  /**
+   * Retrieves an XPath namespace prefix based on a given namespace URI.
+   *
+   * @param      string The namespace URI.
+   *
+   * @return     string The prefix for the namespace URI, or null if none
+   *                    exists.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
+  public static function getAgaviEnvelopePrefix($namespaceUri)
+  {
+    if(self::isAgaviEnvelopeNamespace($namespaceUri)) {
+      return self::$agaviEnvelopeNamespaces[$namespaceUri];
+    }
+    return null;
   }
   
@@ -204 +226 @@
     // cleanup attempt
     unset($docs);
+    
+    // set the pseudo-document URI
+    $retval->documentURI = $path;
     
     return $retval;
@@ -397 +422 @@
         if($matched) {
           // if all was fine, we set the attribute. the element will then be kept in the merged result doc later
-          $configuration->setAttributeNS(self::AGAVI_ENVELOPE_NAMESPACE_LATEST, 'matched', 'true');
+          $configuration->setAttributeNS(self::AGAVI_ENVELOPE_NAMESPACE_LATEST, 'agavi:matched', 'true');
         }
       }

branches/david-xml_only_config_system/src/config/AgaviXmlFactoryConfigHandler.class.php

@@ -31 +31 @@
 class AgaviXmlFactoryConfigHandler extends AgaviXmlConfigHandler
 {
-  const XML_NAMESPACE = 'http://agavi.org/agavi/1.0/config/factories';
+  const NAMESPACE = 'http://agavi.org/agavi/config/factories/1.0';
   
   /**
@@ -48 +48 @@
   public function execute(DOMDocument $doc)
   {
-    echo ($doc->saveXML());
-    
-    // $xsl = new DOMDocument();
-    // $xsl->load(AgaviConfig::get('core.system_config_dir') . '/../xsl/factories.xsl');
-    // 
-    // $xslt = new XSLTProcessor();
-    // $xslt->importStylesheet($xsl);
-    // 
-    // echo ($xslt->transformToDoc($doc)->saveXML());
-    die();
-    
     // set up our default namespace
-    $doc->setDefaultNamespace(self::XML_NAMESPACE, 'factories');
-    
+    $doc->setDefaultNamespace(self::NAMESPACE, 'factories');
+    
+    $config = $doc->documentURI;
     $data = array();
     
@@ -199 +189 @@
     );
     
-    foreach($doc->getConfigurations() as $cfg) {
+    foreach($doc->getConfigurationElements() as $configuration) {
       foreach($factories as $factory => $info) {
-        if($info['required'] && isset($cfg->$factory)) {
+        if(is_array($info) && $info['required'] && $configuration->hasChild($factory)) {
+          $element = $configuration->getChild($factory);
+          
           $data[$factory] = isset($data[$factory]) ? $data[$factory] : array('class' => null, 'params' => array());
-          $data[$factory]['class'] = $cfg->$factory->getAttribute('class', $data[$factory]['class']);
-          $data[$factory]['params'] = $this->getItemParameters($cfg->$factory, $data[$factory]['params']);
+          $data[$factory]['class'] = $element->getAttribute('class', $data[$factory]['class']);
+          $data[$factory]['params'] = $element->getAgaviParameters($data[$factory]['params']);
         }
       }

branches/david-xml_only_config_system/src/config/util/dom/AgaviXmlConfigDomDocument.class.php

@@ -101 +101 @@
     $this->xpath = new DOMXPath($this);
     
+    if($this->isAgaviConfiguration()) {
+      /* Register Agavi namespace prefixes. */
+      foreach(AgaviXmlConfigParser::$agaviEnvelopeNamespaces as $namespaceUri => $prefix) {
+        $this->xpath->registerNamespace($prefix, $namespaceUri);
+      }
+      
+      /* Register the default envelope namespace. */
+      $this->xpath->registerNamespace('agavi_envelope_latest', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST);
+    }
+    
     return $result;
   }
@@ -142 +152 @@
     unset($this->xpath);
     $this->xpath = new DOMXPath($this);
+    
+    if($this->isAgaviConfiguration()) {
+      /* Register Agavi namespace prefixes. */
+      foreach(AgaviXmlConfigParser::$agaviEnvelopeNamespaces as $namespaceUri => $prefix) {
+        $this->xpath->registerNamespace($prefix, $namespaceUri);
+      }
+      
+      /* Register the default envelope namespace. */
+      $this->xpath->registerNamespace('agavi_envelope_latest', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST);
+    }
     
     return $result;

branches/david-xml_only_config_system/src/config/util/dom/AgaviXmlConfigDomElement.class.php

@@ -34 +34 @@
     // what to return here? name with prefix? no.
     // but... element name, or with ns prefix?
+    return $this->nodeName;
   }
   
@@ -55 +56 @@
   {
     // should only pull elements from the default ns
-    // remember to handle special case where we are the document element and an agavi config - must find <configuration> elements from the envelope ns here
-    return $this->ownerDocument->getXpath()->query('child::element()', $this);
-  }
-  
-  public function hasChildren($defaultNamespaceOnly = false)
+    $prefix = $this->ownerDocument->getDefaultNamespacePrefix();
+    if($prefix) {
+      return $this->ownerDocument->getXpath()->query(sprintf('child::%s:element()', $prefix), $this);
+    } else {
+      return $this->ownerDocument->getXpath()->query('child::element()', $this);
+    }
+  }
+  
+  protected function singularize($name)
+  {
+    $names = preg_split('#([_\-\.])#', $name, -1, PREG_SPLIT_DELIM_CAPTURE);
+    $names[count($names) - 1] = AgaviInflector::singularize(end($names));
+    return implode('', $names);
+  }
+  
+  public function countChildren($name, $namespaceUri = null)
   {
     // check for child elements(!) using XPath
     // if arg is true, then only check for elements from our default namespace
-    // remember to handle special case where we are the document element and an agavi config - must find <configuration> elements from the envelope ns here
-  }
-  
-  public function getChildren($defaultNamespaceOnly = false)
+    $namespaceUri = ($namespaceUri === null ? $this->ownerDocument->getDefaultNamespaceUri() : $namespaceUri);
+    $singularName = $this->singularize($name);
+    
+    $xpath = $this->ownerDocument->getXpath();
+    if($namespaceUri) {
+      return (int)$xpath->evaluate(sprintf('count(child::*[local-name() = "%2$s" and namespace-uri() = "%3$s"]) + count(child::*[local-name() = "%1$s" and namespace-uri() = "%3$s"]/*[local-name() = "%2$s" and namespace-uri() = "%3$s"])', $name, $singularName, $namespaceUri), $this);
+    } else {
+      return (int)$xpath->evaluate(sprintf('count(%2$s) + count(%1$s/%2$s)', $name, $singularName), $this);
+    }
+  }
+  
+  public function hasChildren($name, $namespaceUri = null)
+  {
+    return $this->countChildren($name, $namespaceUri) !== 0;
+  }
+  
+  public function getChildren($name, $namespaceUri = null)
   {
     // check for child elements(!) using XPath
     // if arg is true, then only check for elements from our default namespace
-    // remember to handle special case where we are the document element and an agavi config - must find <configuration> elements from the envelope ns here
+    // if namespace uri is null, use default ns. if empty string, use no ns
+    $namespaceUri = ($namespaceUri === null ? $this->ownerDocument->getDefaultNamespaceUri() : $namespaceUri);
+    $singularName = $this->singularize($name);
+    
+    $xpath = $this->ownerDocument->getXpath();
+    if($namespaceUri) {
+      return $xpath->query(sprintf('child::*[local-name() = "%2$s" and namespace-uri() = "%3$s"] | child::*[local-name() = "%1$s" and namespace-uri() = "%3$s"]/*[local-name() = "%2$s" and namespace-uri() = "%3$s"]', $name, $singularName, $namespaceUri), $this);
+    } else {
+      return $xpath->query(sprintf('%1$s/%2$s | %2$s', $name, $singularName), $this);
+    }
   }
   
@@ -76 +110 @@
   {
     // if namespace uri is null, use default ns. if empty string, use no ns
-    // remember to handle special case where we are the document element and an agavi config - must find <configuration> elements from the envelope ns here
+    return $this->countChildren($name) === 1;
+    
+    // XXX: not necessary for single elements?
     // remember singular/plural support
   }
   
+  /**
+   * Returns a single child element with a given name.
+   *
+   * @param      string The name of the element.
+   * @param      string The namespace URI. If null, the document default
+   *                    namespace will be used. If an empty string, no namespace
+   *                    will be used.
+   *
+   * @return     DOMElement The child element, or null if none xists.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
   public function getChild($name, $namespaceUri = null)
   {
-    // if namespace uri is null, use default ns. if empty string, use no ns
-    // remember to handle special case where we are the document element and an agavi config - must find <configuration> elements from the envelope ns here
+    $list = $this->getChildren($name, $namespaceUri);
+    
+    if($list->length > 0) {
+      return $list->item(0);
+    }
+    return null;
   }
   
@@ -141 +194 @@
   }
   
-  public function getAgaviParameters()
-  {
-    return $this->ownerDocument->xpath->query('child::aens:parameters | child::aens:parameter');
+  public function getAgaviParameters(array $existing = array())
+  {
+    if($this->ownerDocument->isAgaviConfiguration()) {
+      $elements = $this->getChildren('parameters', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST);
+      $result = array();
+      
+      foreach($elements as $element) {
+        if($element->hasChildren('parameters', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST)) {
+          $result[$element->getAttribute('name')] = $element->getAgaviParameters();
+        } else {
+          $result[$element->getAttribute('name')] = $element->getValue();
+        }
+      }
+      
+      return array_merge($existing, $result);
+    } else {
+      return $existing;
+    }
   }
 }

branches/david-xml_only_config_system/src/config/util/xsl/AgaviXmlConfigXsltProcessor.class.php

@@ -45 +45 @@
    * @param      DOMNode The node to transform.
    *
-   * @return     DOMDocument The resulting DOMDocument.
+   * @return     AgaviXmlConfigDomDocument The resulting DOMDocument.
    *
    * @author     Noah Fontes <noah.fontes@bitextender.com>

branches/david-xml_only_config_system/src/config/xsl/_common.xsl

@@ -3 +3 @@
   version="1.0"
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-  xmlns:agavi10="http://agavi.org/agavi/1.0/config"
->
+  xmlns:envelope_0_11="http://agavi.org/agavi/1.0/config"
+  xmlns:envelope_1_0="http://agavi.org/agavi/config/1.0">
   
-  <xsl:template match="agavi10:configurations | agavi10:configuration | agavi10:sandbox | agavi10:parameters | agavi10:parameter">
-    <xsl:element name="{local-name()}" namespace="{namespace-uri()}">
+  <xsl:variable name="envelope_0_11" select="'http://agavi.org/agavi/1.0/config'" />
+  <xsl:variable name="envelope_1_0" select="'http://agavi.org/agavi/config/1.0'" />
+  
+  <xsl:template match="envelope_0_11:configurations | envelope_0_11:configuration | envelope_0_11:sandbox | envelope_0_11:parameters | envelope_0_11:parameter">
+    <xsl:element name="{local-name()}" namespace="{$envelope_1_0}">
       <xsl:copy-of select="@*" />
       <xsl:apply-templates />

branches/david-xml_only_config_system/src/config/xsl/factories.xsl

@@ -3 +3 @@
   version="1.0"
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-  xmlns:agavi10="http://agavi.org/agavi/1.0/config"
-  xmlns:factories10="http://agavi.org/agavi/1.0/config/factories"
-  xmlns:factories11="http://agavi.org/agavi/1.1/config/factories"
+  xmlns:envelope_0_11="http://agavi.org/agavi/1.0/config"
+  xmlns:factories_1_0="http://agavi.org/agavi/config/factories/1.0"
 >
-
+  <!--xmlns:factories_1_1="http://agavi.org/agavi/1.1/config/factories"-->
+  
+  <xsl:output method="xml" version="1.0" encoding="utf-8" indent="yes" />
+  
   <xsl:include href="_common.xsl" />
-
-  <xsl:variable name="agavi10" select="'http://agavi.org/agavi/1.0/config'" />
-  <xsl:variable name="factories10" select="'http://agavi.org/agavi/1.0/config/factories'" />
-  <xsl:variable name="factories11" select="'http://agavi.org/agavi/1.1/config/factories'" />
-
-  <xsl:output method="xml" version="1.0" encoding="utf-8" indent="yes" />
+  
+  <xsl:variable name="factories_1_0" select="'http://agavi.org/agavi/config/factories/1.0'" />
+  <!--<xsl:variable name="factories11" select="'http://agavi.org/agavi/1.1/config/factories'" />-->
   
   <!-- pre-1.0 backwards compatibility for 1.0 -->
   <!-- non-"envelope" elements are copied to the 1.0 factories namespace -->
-  <xsl:template match="agavi10:*">
-    <xsl:element name="{local-name()}" namespace="{$factories10}">
+  <xsl:template match="envelope_0_11:*">
+    <xsl:element name="{local-name()}" namespace="{$factories_1_0}">
       <xsl:copy-of select="@*" />
       <xsl:apply-templates />
@@ -27 +26 @@
   <!-- 1.0 BC for 1.1 -->
   <!-- namespace is simply changed to 1.1 for all elements except <storage> -->
-  <xsl:template match="factories10:*">
+  <!-- <xsl:template match="factories10:*">
     <xsl:element name="{local-name()}" namespace="{$factories11}">
       <xsl:copy-of select="@*" />
@@ -37 +36 @@
       <xsl:apply-templates />
     </factories11:storage_manager>
-  </xsl:template>
+  </xsl:template> -->
   
 </xsl:stylesheet>