Fixed a bug in recursive get(), sitemap driver + various fixes

Author: Cédric de Saint Léger

classes/xml/core.php

@@ -8,8 +8,7 @@
  *      XML_Core class.
  */
 
- class XML_Core
- {
+class XML_Core {
 	/**
 	 * @var string XML document version
 	 */
@@ -77,8 +76,8 @@ public static function factory($driver = NULL, $root_node = NULL, $element = NUL
 			return new XML($element, $root_node);
 		}
 	}
-	
-	
+
+
 	/**
 	 * Class constructor. You should use the factory instead.
 	 * @param string $element [optional] What to construct from. Could be some xml string, a file name, or a DOMNode
@@ -136,10 +135,10 @@ public function __construct($element = NULL, $root_node = NULL)
 				// Create the root node
 				$root_node = $this->dom_doc->createElement($this->root_node);
 			}
-			
+
 			// Append the root node to the object DOMDocument, and set the resulting DOMNode as it's node
 			$this->dom_node = $this->dom_doc->appendChild($root_node);
-			
+
 			// Add other attributes
 			$this->add_attributes($this->dom_node);
 		}
@@ -159,31 +158,24 @@ public function __construct($element = NULL, $root_node = NULL)
 	 * @return XML instance for the node that's been added.
 	 */
 	public function add_node($name, $value = NULL, $attributes = array())
-	{	
+	{
 		// Trim the name
 		$name = trim($name);
-		
+
 		// Create the element
 		$node = $this->create_element($name);
 
 		// Add the attributes
 		$this->add_attributes($node, $attributes);
-		
+
 		// Add the value if provided
 		if ($value !== NULL)
-		{			
-			$value = strval($this->filter($name, $value, &$node));
-			
-			if (str_replace(array('<', '>', '&'), "", $value) === $value)
-			{
-				// Value is valid CDATA, let's add it as a new text node
-				$value = $this->dom_doc->createTextNode($value);
-			}
-			else
-			{
-				// We shall create a CDATA section to wrap the text provided
-				$value = $this->dom_doc->createCDATASection($value);
-			}
+		{
+			$value = strval($this->filter($name, $value, $node));
+
+			// Value is valid CDATA, let's add it as a new text node
+			$value = $this->dom_doc->createTextNode($value);
+
 			$node->appendChild($value);
 		}
 
@@ -207,7 +199,7 @@ public function __get($value)
 		if ( ! isset($this->$value))
 		{
 			$node = current($this->get($value));
-			
+
 			if ($node instanceof XML)
 			{
 				// Return the whole XML document
@@ -231,7 +223,7 @@ public function __get($value)
 	public function get($value, $as_array = FALSE)
 	{
 		$return = array();
-		
+
 		$value = $this->meta()->alias($value);
 
 		foreach ($this->dom_node->getElementsByTagName($value) as $item)
@@ -264,9 +256,9 @@ public function get($value, $as_array = FALSE)
 	public function xpath($query, $as_array = TRUE)
 	{
 		$return = array();
-		
+
 		$xpath = new DOMXPath($this->dom_doc);
-		
+
 		foreach ($xpath->query($query) as $item)
 		{
 			if ($as_array)
@@ -291,9 +283,9 @@ public function xpath($query, $as_array = TRUE)
 	/**
 	 * Exports the document as a multi-dimensional array.
 	 * Handles element with the same name.
-	 * 
+	 *
 	 * Root node is ignored, as it is known and available in the driver.
-	 * Example : 
+	 * Example :
 	 * <node_name attr_name="val">
 	 * 		<child_node_name>
 	 * 			value1
@@ -302,17 +294,17 @@ public function xpath($query, $as_array = TRUE)
 	 * 			value2
 	 * 		</child_node_name>
 	 * </node_name>
-	 * 
+	 *
 	 * Here's the resulting array structure :
 	 * array ("node_name" => array(
-	 * 					// array of nodes called "node_name"	
+	 * 					// array of nodes called "node_name"
 	 * 					0 => array(
 	 *							// Attributes of that node
 	 *							"xml_attributes" => array(
 	 *											"attr_name" => "val",
 	 *													)
 	 *							// node contents
-	 * 							"child_node_name" => array( 
+	 * 							"child_node_name" => array(
 	 * 												// array of nodes called "child_node_name"
 	 * 												0 => value1,
 	 * 												1 => value2,
@@ -323,9 +315,9 @@ public function xpath($query, $as_array = TRUE)
 	public function as_array()
 	{
 		$dom_element = $this->dom_node;
-		
+
 		$return = array();
-		
+
 		// This function is run on a whole XML document and this is the root node.
 		// That root node shall be ignored in the array as it driven by the driver and handles document namespaces.
 		foreach($dom_element->childNodes as $dom_child)
@@ -341,7 +333,7 @@ public function as_array()
 				}
 			}
 		}
-		
+
 		return $return;
 	}
 
@@ -374,7 +366,7 @@ private function _as_array(DOMNode $dom_node)
 				if ($dom_child->nodeType === XML_ELEMENT_NODE)
 				{
 					$child = $this->_as_array($dom_child);
-	
+
 					foreach ($child as $key=>$val)
 					{
 						$object_element[$node_name][$key][]=$val;
@@ -386,7 +378,7 @@ private function _as_array(DOMNode $dom_node)
 		// Get attributes
 		if ($dom_node->hasAttributes())
 		{
-	 		$object_element[$dom_node->nodeName]['xml_attributes'] = array();
+	 		$object_element[$node_name] = array('xml_attributes' => array());
 			foreach($dom_node->attributes as $att_name => $dom_attribute)
 			{
 				// Get the desired name for this attribute
@@ -451,13 +443,13 @@ protected function _from_array($mixed, DOMElement $dom_element)
 					// Create a new element with the key as the element name.
 					// Create the element corresponding to the key
 					$node = $this->create_element($index);
-					
+
 					// Add the driver attributes
 					$this->add_attributes($node);
 
 					// Append it
 					$dom_element->appendChild($node);
-					
+
 					// Treat the array by recursion
 					$this->_from_array($mixed_element, $node);
 				}
@@ -466,7 +458,7 @@ protected function _from_array($mixed, DOMElement $dom_element)
 		elseif ($mixed)
 		{
 			// This is a string value that shall be appended as such
-			$mixed = $this->filter($dom_element->tagName, $mixed, &$dom_element);
+			$mixed = $this->filter($dom_element->tagName, $mixed, $dom_element);
 			$dom_element->appendChild($this->dom_doc->createTextNode($mixed));
 		}
 	}
@@ -499,7 +491,7 @@ public function import($xml)
 		// Import the node, and all its children, to the document
 		$node = $this->dom_doc->importNode($xml->dom_node, TRUE);
 		$this->dom_node->appendChild($node);
-		
+
 		return $this;
 	}
 
@@ -605,7 +597,7 @@ private function add_attributes(DOMNode $node, $attributes = array())
 	protected function filter($name, $value, &$node)
 	{
 		$name = $this->meta()->alias($name);
-		
+
 		if ($this->meta()->get("filter", $name))
 		{
 			return call_user_func(array($this, $this->meta()->get("filter", $name)), $value, $node);

classes/xml/driver/atom.php

@@ -8,8 +8,8 @@
  *      Atom driver
  */
 
-class XML_Driver_Atom extends XML
-{
+class XML_Driver_Atom extends XML {
+
 	public $root_node = 'feed';
 
 

classes/xml/driver/rss2.php

@@ -8,8 +8,8 @@
  *      RSS2 driver
  */
 
-class XML_Driver_Rss2 extends XML
-{
+class XML_Driver_Rss2 extends XML {
+
 	public $root_node = 'rss';
 
 	protected static function initialize(XML_Meta $meta)

classes/xml/driver/sitemap.php

@@ -0,0 +1,98 @@
+<?php defined('SYSPATH') or die('No direct script access.');
+/**
+ *	Document   : sitemap.php
+ *	Created on : 1 mai 2009, 13:03:03
+ *	@author Cedric de Saint Leger <[email protected]>
+ *
+ *	Description:
+ *      Sitemap driver
+ * 		http://www.sitemaps.org/protocol.html
+ */
+
+class XML_Driver_Sitemap extends XML {
+
+	public $root_node = 'urlset';
+
+
+	protected static function initialize(XML_Meta $meta)
+	{
+		$meta	->nodes (
+							array(
+								"urlset"				=> array("namespace"	=> "http://www.sitemaps.org/schemas/sitemap/0.9"),
+								"loc"					=> array("filter"		=> "normalize_uri"),
+								"lastmod"				=> array("filter"		=> "normalize_date"),
+
+								// Sitemap extensions
+								// Videos
+								// http://support.google.com/webmasters/bin/answer.py?hl=fr&answer=80472
+								"video:video"			=> array("namespace"	=> "http://www.google.com/schemas/sitemap-video/1.1"),
+								"video:thumbnail_loc"	=> array("filter"		=> "normalize_uri"),
+								"video:content_loc"		=> array("filter"		=> "normalize_uri"),
+								"video:player_loc"		=> array("filter"		=> "normalize_uri"),
+								"video:expiration_date"	=> array("filter"		=> "normalize_datetime"),
+
+								// Images
+								// http://support.google.com/webmasters/bin/answer.py?hl=fr&answer=178636&topic=20986&ctx=topic
+								"image:image"			=> array("namespace"	=> "http://www.google.com/schemas/sitemap-image/1.1"),
+								"image:loc"				=> array("filter"		=> "normalize_uri"),
+
+								// News
+								// http://support.google.com/webmasters/bin/answer.py?hl=en&answer=74288
+								"news:news"				=> array("namespace"	=> "http://www.google.com/schemas/sitemap-news/0.9"),
+								"news:publication_date"	=> array("filter"		=> "normalize_date"),
+
+								// Mobile
+								// http://support.google.com/webmasters/bin/answer.py?hl=fr&answer=34648
+								"mobile:mobile"			=> array("namespace"	=> "http://www.google.com/schemas/sitemap-mobile/1.0"),
+
+								// Code Search
+								// http://support.google.com/webmasters/bin/answer.py?hl=fr&answer=75225
+								"codesearch:codesearch"	=> array("namespace"	=> "http://www.google.com/codesearch/schemas/sitemap/1.0"),
+								)
+						);
+	}
+
+
+	public function add_url($url, $options = array(), $extensions = array())
+	{
+		$url_node = $this->add_node("url");
+		$url_node->add_node("loc", $url);
+		foreach ($options as $key => $val)
+		{
+			$url_node->add_node($key, $val);
+		}
+		foreach ($extensions as $extension => $params)
+		{
+			$extension = $url_node->add_node("$extension:$extension");
+			foreach ($params as $key => $val)
+			{
+				$extension->add_node($key, $val);
+			}
+		}
+		return $this;
+	}
+
+
+	public function normalize_datetime($value)
+	{
+		if ( ! is_numeric($value))
+		{
+			$value = strtotime($value);
+		}
+
+		// Convert timestamps to W3C format datetime
+		return date(DATE_W3C, $value);
+	}
+
+
+	public function normalize_date($value)
+	{
+		if ( ! is_numeric($value))
+		{
+			$value = strtotime($value);
+		}
+
+		// Convert timestamps to RFC 3339 formatted dates
+		return date("Y-m-d", $value);
+	}
+}

classes/xml/driver/xrds.php

@@ -8,10 +8,10 @@
  *      XRDS driver. For Service Discovery.
  */
 
-class XML_Driver_XRDS extends XML
-{
+class XML_Driver_XRDS extends XML {
+
 	public $root_node = 'xrds:XRDS';
-						
+
 	protected static function initialize(XML_Meta $meta)
 	{
 		$meta	->content_type("application/xrds+xml")
@@ -24,8 +24,8 @@ protected static function initialize(XML_Meta $meta)
 								)
 						);
 	}
-								
-								
+
+
 	public function add_service($type, $uri, $priority = NULL)
 	{
 		if (! is_null($priority))
@@ -36,20 +36,20 @@ public function add_service($type, $uri, $priority = NULL)
 		{
 			$priority = array();
 		}
-		
+
 		$service_node = $this->add_node("Service", NULL, $priority);
 
 		if (! is_array($type))
 		{
 			$type = array($type);
 		}
-		
+
 		foreach ($type as $t)
 		{
 			$service_node->add_node("Type", $t);
 		}
 		$service_node->add_node("URI", $uri);
-		
+
 		return $service_node;
 	}
 }

classes/xml/meta.php

@@ -8,5 +8,4 @@
  *      XML_Meta class. Use this to override XML_Meta_Core
  */
 
- class XML_Meta extends XML_Meta_Core
- {}
+class XML_Meta extends XML_Meta_Core {}