Index: xml_parser.module
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/xml_parser/xml_parser.module,v
retrieving revision 1.1
diff -u -r1.1 xml_parser.module
--- xml_parser.module	11 Feb 2010 17:51:34 -0000	1.1
+++ xml_parser.module	23 Feb 2010 10:16:54 -0000
@@ -1,196 +1,243 @@
-<?php
-// $Id
-
-/**
- * This function receives the path to an XML document and 
- * returns the contents of the document as a string.
- * 
- * @param $file 
- * (string) The system path to an XML file.
- * 
- * @return
- * (string) The contents of the XML file as a string ready
- * to be parsed or FALSE if the file could not be opened.
- */
-function xml_parser_load_xml($file) {
-     
-  // load xml file into string
-  if ($xmlfile = fopen($file, "r")) {
-    while(!feof($xmlfile)) {
-      $str = $str . fgets($xmlfile, 4096);
-    }
-    fclose($xmlfile);
-    return $str;
-  }
-  // otherwise report problem
-  else {
-    watchdog('xml_parser', t('Could not open XML file: '.$file), array(), WATCHDOG_ERROR);
-    return FALSE;
-  } 
-}
-
-/**
- * This function receives the path to an XML document and 
- * returns the contents of the document as an array.
- * 
- * @param $str 
- * (string) An XML file as a string, typically prepared by
- * the xml_parser_load_xml() function.
- * 
- * @return
- * (array) The contents of the XML file as a keyed array.
- * Array[0] contains the schema.
- */
-function xml_parser_string_to_array($str) {
-  $xmlClass = new XML_Unserializer;
-  
-  // parse into array
-  $xmlClass->unserialize($str);
-  $xmlArray = $xmlClass->get_unserialized_data();
-           
-  return $xmlArray;
-}
-
-/**
- * Use this function if you do not need to manipulate the
- * XML string and just want to send the string directly
- * to be converted in to a PHP array.
- * 
- * @param $file 
- * (string) The system path to an XML file.
- * 
- * @return
- * (array) The contents of the XML file as a keyed array.
- * Array[0] contains the schema or FALSE if no file was
- * loaded.
- */
-function xml_parser_xml_to_array($file) {
-  $str = xml_parser_load_xml($file);
-  if ($str) {
-    $output = xml_parser_string_to_array($str);
-    return $output;
-  }
-  else {
-    return FALSE;
-  }
-}
-
-/**
- * @file
- * This class contains a collection of function for 
- * parsing XML files
- */
-class XML_Unserializer {
-  var $stack;
-  var $arr_output;
-  var $null_token = "null";
-
-  function unserialize($str_input_xml) {
-    $p = xml_parser_create();
-    xml_set_element_handler($p, array(&$this, 'start_handler'), array(&$this, 'end_handler'));
-    xml_set_character_data_handler($p, array(&$this, 'data_handler'));
-    $this->stack = array(
-      array(
-        'name' => 'document',
-        'attributes' => array(),
-        'children' => array(),
-        'data' => ''
-       )
-    );
-    if (!xml_parse($p, $str_input_xml)) {
-      trigger_error(xml_error_string(xml_get_error_code($p)) ."\n". $str_input_xml, E_USER_NOTICE);
-      xml_parser_free($p);
-      return;
-    }
-    xml_parser_free($p);
-
-    $tmp = $this->build_array($this->stack[0]);
-    if (count($tmp) == 1) {
-      $this->arr_output = array_pop($tmp);
-    }
-    else {
-      $this->arr_output = array();
-    }
-    unset($this->stack);
-    return $this->arr_output;
-  }
-
-  function get_unserialized_data() {
-    return $this->arr_output;
-  }
-
-  function build_array($stack) {
-    $result = array();
-    if (count($stack['attributes']) > 0) {
-      $result = array_merge($result, $stack['attributes']);
-    }
-
-    if (count($stack['children']) > 0) {
-      if (count($stack['children']) == 1) {
-        $key = array_keys($stack['children']);
-        //krumo($stack['children']);
-        if ($stack['children'][$key[0]]['name'] === $this->null_token) {
-          return NULL;
-        }
-      }
-      $keycount = array();
-      foreach ($stack['children'] as $child) {
-        $keycount[] = $child['name'];
-      }
-      if (count(array_unique($keycount)) != count($keycount)) {
-        // enumerated array
-        $children = array();
-        foreach ($stack['children'] as $child) {
-          $children[] = $this->build_array($child);
-        }
-      }
-      else {
-        // indexed array
-        $children = array();
-        foreach ($stack['children'] as $child) {
-          $children[$child['name']] = $this->build_array($child);
-        }
-      }
-      $result = array_merge($result, $children);
-    }
-
-    if (count($result) == 0) {
-      return trim($stack['data']);
-    }
-    else {
-      return $result;
-    }
-  }
-
-  function start_handler($parser, $name, $attribs = array()) {
-    $token = array();
-    $token['name'] = strtolower($name);
-    $token['attributes'] = $attribs;
-    $token['data'] = '';
-    $token['children'] = array();
-    $this->stack[] = $token;
-  }
-
-  function end_handler($parser, $name, $attribs = array()) {
-    $token = array_pop($this->stack);
-    $this->stack[count($this->stack) - 1]['children'][] = $token;
-  }
-
-  function data_handler($parser, $data) {
-    $this->stack[count($this->stack) - 1]['data'] .= $data;
-  }
-}
-
-function xml_serialize($tagname, $data) {
-  $xml = "<$tagname>";
-  if (is_array($data)) {
-    foreach ($data as $key => $value) {
-      $xml .= xml_serialize($key, $value);
-    }
-  }
-  else {
-    $xml .= "<![CDATA[".$data."]]>";
-  }
-  $xml .= "</$tagname>\n";
-  return $xml;
-}
+<?php
+// $Id
+
+/**
+ * This function receives the path to an XML document and 
+ * returns the contents of the document as a string.
+ * 
+ * @param $file 
+ * (string) The system path to an XML file.
+ * 
+ * @return
+ * (string) The contents of the XML file as a string ready
+ * to be parsed or FALSE if the file could not be opened.
+ */
+function xml_parser_load_xml($file) {
+     
+  // load xml file into string
+  if ($xmlfile = fopen($file, "r")) {
+    while(!feof($xmlfile)) {
+      $str = $str . fgets($xmlfile, 4096);
+    }
+    fclose($xmlfile);
+    return $str;
+  }
+  // otherwise report problem
+  else {
+    watchdog('xml_parser', t('Could not open XML file: '.$file), array(), WATCHDOG_ERROR);
+    return FALSE;
+  } 
+}
+
+/**
+ * This function receives the path to an XML document and 
+ * returns the contents of the document as an array.
+ * 
+ * @param $str 
+ * (string) An XML file as a string, typically prepared by
+ * the xml_parser_load_xml() function.
+ * 
+ * @return
+ * (array) The contents of the XML file as a keyed array.
+ * Array[0] contains the schema.
+ */
+function xml_parser_string_to_array($str) {
+  $xmlClass = new XML_Unserializer;
+  
+  // parse into array
+  $xmlClass->unserialize($str);
+  $xmlArray = $xmlClass->get_unserialized_data();
+           
+  return $xmlArray;
+}
+
+/**
+ * Use this function if you do not need to manipulate the
+ * XML string and just want to send the string directly
+ * to be converted in to a PHP array.
+ * 
+ * @param $file 
+ * (string) The system path to an XML file.
+ * 
+ * @return
+ * (array) The contents of the XML file as a keyed array.
+ * Array[0] contains the schema or FALSE if no file was
+ * loaded.
+ */
+function xml_parser_xml_to_array($file) {
+  $str = xml_parser_load_xml($file);
+  if ($str) {
+    $output = xml_parser_string_to_array($str);
+    return $output;
+  }
+  else {
+    return FALSE;
+  }
+}
+
+/**
+ * This function receives the URL to an external XML document and 
+ * returns the contents of the document as a string.
+ * 
+ * @param $file 
+ * (string) URL to an external XML file.
+ * 
+ * @return
+ * (string) The contents of the XML file as a string ready
+ * to be parsed or FALSE if the file could not be retrieved.
+ */
+function xml_parser_load_url_xml($url) {
+  $response = drupal_http_request($url);   
+  // if there was an error handle it
+  if ($response->code != 200) {
+    watchdog('xml_parser', t('Could not retrieve XML file from: '.$url), array(), WATCHDOG_ERROR);
+    return FALSE;
+  }
+  else {     
+    $str = $response->data;
+    return $str;
+  }
+}
+
+/**
+ * Use this function if you do not need to manipulate the
+ * XML string obtained from an external URL and just want to send the string directly
+ * to be converted in to a PHP array.
+ * 
+ * @param $file 
+ * (string) URL to an external XML file.
+ * 
+ * @return
+ * (array) The contents of the XML file as a keyed array.
+ * Array[0] contains the schema or FALSE if no file was
+ * loaded.
+ */
+function xml_parser_url_xml_to_array($url) {
+  $str = xml_parser_load_url_xml($url);
+  if ($str) {
+    $output = xml_parser_string_to_array($str);
+    return $output;
+  }
+  else {
+    return FALSE;
+  }
+}
+/**
+ * @file
+ * This class contains a collection of function for 
+ * parsing XML files
+ */
+class XML_Unserializer {
+  var $stack;
+  var $arr_output;
+  var $null_token = "null";
+
+  function unserialize($str_input_xml) {
+    $p = xml_parser_create();
+    xml_set_element_handler($p, array(&$this, 'start_handler'), array(&$this, 'end_handler'));
+    xml_set_character_data_handler($p, array(&$this, 'data_handler'));
+    $this->stack = array(
+      array(
+        'name' => 'document',
+        'attributes' => array(),
+        'children' => array(),
+        'data' => ''
+       )
+    );
+    if (!xml_parse($p, $str_input_xml)) {
+      trigger_error(xml_error_string(xml_get_error_code($p)) ."\n". $str_input_xml, E_USER_NOTICE);
+      xml_parser_free($p);
+      return;
+    }
+    xml_parser_free($p);
+
+    $tmp = $this->build_array($this->stack[0]);
+    if (count($tmp) == 1) {
+      $this->arr_output = array_pop($tmp);
+    }
+    else {
+      $this->arr_output = array();
+    }
+    unset($this->stack);
+    return $this->arr_output;
+  }
+
+  function get_unserialized_data() {
+    return $this->arr_output;
+  }
+
+  function build_array($stack) {
+    $result = array();
+    if (count($stack['attributes']) > 0) {
+      $result = array_merge($result, $stack['attributes']);
+    }
+
+    if (count($stack['children']) > 0) {
+      if (count($stack['children']) == 1) {
+        $key = array_keys($stack['children']);
+        //krumo($stack['children']);
+        if ($stack['children'][$key[0]]['name'] === $this->null_token) {
+          return NULL;
+        }
+      }
+      $keycount = array();
+      foreach ($stack['children'] as $child) {
+        $keycount[] = $child['name'];
+      }
+      if (count(array_unique($keycount)) != count($keycount)) {
+        // enumerated array
+        $children = array();
+        foreach ($stack['children'] as $child) {
+          $children[] = $this->build_array($child);
+        }
+      }
+      else {
+        // indexed array
+        $children = array();
+        foreach ($stack['children'] as $child) {
+          $children[$child['name']] = $this->build_array($child);
+        }
+      }
+      $result = array_merge($result, $children);
+    }
+
+    if (count($result) == 0) {
+      return trim($stack['data']);
+    }
+    else {
+      return $result;
+    }
+  }
+
+  function start_handler($parser, $name, $attribs = array()) {
+    $token = array();
+    $token['name'] = strtolower($name);
+    $token['attributes'] = $attribs;
+    $token['data'] = '';
+    $token['children'] = array();
+    $this->stack[] = $token;
+  }
+
+  function end_handler($parser, $name, $attribs = array()) {
+    $token = array_pop($this->stack);
+    $this->stack[count($this->stack) - 1]['children'][] = $token;
+  }
+
+  function data_handler($parser, $data) {
+    $this->stack[count($this->stack) - 1]['data'] .= $data;
+  }
+}
+
+function xml_serialize($tagname, $data) {
+  $xml = "<$tagname>";
+  if (is_array($data)) {
+    foreach ($data as $key => $value) {
+      $xml .= xml_serialize($key, $value);
+    }
+  }
+  else {
+    $xml .= "<![CDATA[".$data."]]>";
+  }
+  $xml .= "</$tagname>\n";
+  return $xml;
+}