Parser.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437
  1. <?php
  2. /**
  3. * SimplePie
  4. *
  5. * A PHP-Based RSS and Atom Feed Framework.
  6. * Takes the hard work out of managing a complete RSS/Atom solution.
  7. *
  8. * Copyright (c) 2004-2016, Ryan Parman, Geoffrey Sneddon, Ryan McCue, and contributors
  9. * All rights reserved.
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification, are
  12. * permitted provided that the following conditions are met:
  13. *
  14. * * Redistributions of source code must retain the above copyright notice, this list of
  15. * conditions and the following disclaimer.
  16. *
  17. * * Redistributions in binary form must reproduce the above copyright notice, this list
  18. * of conditions and the following disclaimer in the documentation and/or other materials
  19. * provided with the distribution.
  20. *
  21. * * Neither the name of the SimplePie Team nor the names of its contributors may be used
  22. * to endorse or promote products derived from this software without specific prior
  23. * written permission.
  24. *
  25. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
  26. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  27. * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
  28. * AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  32. * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33. * POSSIBILITY OF SUCH DAMAGE.
  34. *
  35. * @package SimplePie
  36. * @copyright 2004-2016 Ryan Parman, Geoffrey Sneddon, Ryan McCue
  37. * @author Ryan Parman
  38. * @author Geoffrey Sneddon
  39. * @author Ryan McCue
  40. * @link http://simplepie.org/ SimplePie
  41. * @license http://www.opensource.org/licenses/bsd-license.php BSD License
  42. */
  43. /**
  44. * Parses XML into something sane
  45. *
  46. *
  47. * This class can be overloaded with {@see SimplePie::set_parser_class()}
  48. *
  49. * @package SimplePie
  50. * @subpackage Parsing
  51. */
  52. class SimplePie_Parser
  53. {
  54. var $error_code;
  55. var $error_string;
  56. var $current_line;
  57. var $current_column;
  58. var $current_byte;
  59. var $separator = ' ';
  60. var $namespace = array('');
  61. var $element = array('');
  62. var $xml_base = array('');
  63. var $xml_base_explicit = array(false);
  64. var $xml_lang = array('');
  65. var $data = array();
  66. var $datas = array(array());
  67. var $current_xhtml_construct = -1;
  68. var $encoding;
  69. protected $registry;
  70. public function set_registry(SimplePie_Registry $registry)
  71. {
  72. $this->registry = $registry;
  73. }
  74. public function parse(&$data, $encoding)
  75. {
  76. $xmlEncoding = '';
  77. if (!empty($encoding))
  78. {
  79. // Use UTF-8 if we get passed US-ASCII, as every US-ASCII character is a UTF-8 character
  80. if (strtoupper($encoding) === 'US-ASCII')
  81. {
  82. $this->encoding = 'UTF-8';
  83. }
  84. else
  85. {
  86. $this->encoding = $encoding;
  87. }
  88. // Strip BOM:
  89. // UTF-32 Big Endian BOM
  90. if (substr($data, 0, 4) === "\x00\x00\xFE\xFF")
  91. {
  92. $data = substr($data, 4);
  93. }
  94. // UTF-32 Little Endian BOM
  95. elseif (substr($data, 0, 4) === "\xFF\xFE\x00\x00")
  96. {
  97. $data = substr($data, 4);
  98. }
  99. // UTF-16 Big Endian BOM
  100. elseif (substr($data, 0, 2) === "\xFE\xFF")
  101. {
  102. $data = substr($data, 2);
  103. }
  104. // UTF-16 Little Endian BOM
  105. elseif (substr($data, 0, 2) === "\xFF\xFE")
  106. {
  107. $data = substr($data, 2);
  108. }
  109. // UTF-8 BOM
  110. elseif (substr($data, 0, 3) === "\xEF\xBB\xBF")
  111. {
  112. $data = substr($data, 3);
  113. }
  114. if (substr($data, 0, 5) === '<?xml' && strspn(substr($data, 5, 1), "\x09\x0A\x0D\x20") && ($pos = strpos($data, '?>')) !== false)
  115. {
  116. $declaration = $this->registry->create('XML_Declaration_Parser', array(substr($data, 5, $pos - 5)));
  117. if ($declaration->parse())
  118. {
  119. $xmlEncoding = strtoupper($declaration->encoding); //FreshRSS
  120. $data = substr($data, $pos + 2);
  121. $data = '<?xml version="' . $declaration->version . '" encoding="' . $encoding . '" standalone="' . (($declaration->standalone) ? 'yes' : 'no') . '"?>' . $data;
  122. }
  123. else
  124. {
  125. $this->error_string = 'SimplePie bug! Please report this!';
  126. return false;
  127. }
  128. }
  129. }
  130. if ($xmlEncoding === '' || $xmlEncoding === 'UTF-8') //FreshRSS: case of no explicit HTTP encoding, and lax UTF-8
  131. {
  132. try
  133. {
  134. $dom = new DOMDocument();
  135. $dom->recover = true;
  136. $dom->strictErrorChecking = false;
  137. @$dom->loadXML($data);
  138. $this->encoding = $encoding = $dom->encoding = 'UTF-8';
  139. $data2 = $dom->saveXML();
  140. if (function_exists('mb_convert_encoding'))
  141. {
  142. $data2 = mb_convert_encoding($data2, 'UTF-8', 'UTF-8');
  143. }
  144. if (strlen($data2) > (strlen($data) / 2.0))
  145. {
  146. $data = $data2;
  147. }
  148. unset($data2);
  149. }
  150. catch (Exception $e)
  151. {
  152. }
  153. }
  154. $return = true;
  155. static $xml_is_sane = null;
  156. if ($xml_is_sane === null)
  157. {
  158. $parser_check = xml_parser_create();
  159. xml_parse_into_struct($parser_check, '<foo>&amp;</foo>', $values);
  160. xml_parser_free($parser_check);
  161. $xml_is_sane = isset($values[0]['value']);
  162. }
  163. // Create the parser
  164. if ($xml_is_sane)
  165. {
  166. $xml = xml_parser_create_ns($this->encoding, $this->separator);
  167. xml_parser_set_option($xml, XML_OPTION_SKIP_WHITE, 1);
  168. xml_parser_set_option($xml, XML_OPTION_CASE_FOLDING, 0);
  169. xml_set_object($xml, $this);
  170. xml_set_character_data_handler($xml, 'cdata');
  171. xml_set_element_handler($xml, 'tag_open', 'tag_close');
  172. // Parse!
  173. if (!xml_parse($xml, $data, true))
  174. {
  175. $this->error_code = xml_get_error_code($xml);
  176. $this->error_string = xml_error_string($this->error_code);
  177. $return = false;
  178. }
  179. $this->current_line = xml_get_current_line_number($xml);
  180. $this->current_column = xml_get_current_column_number($xml);
  181. $this->current_byte = xml_get_current_byte_index($xml);
  182. xml_parser_free($xml);
  183. return $return;
  184. }
  185. else
  186. {
  187. libxml_clear_errors();
  188. $xml = new XMLReader();
  189. $xml->xml($data);
  190. while (@$xml->read())
  191. {
  192. switch ($xml->nodeType)
  193. {
  194. case constant('XMLReader::END_ELEMENT'):
  195. if ($xml->namespaceURI !== '')
  196. {
  197. $tagName = $xml->namespaceURI . $this->separator . $xml->localName;
  198. }
  199. else
  200. {
  201. $tagName = $xml->localName;
  202. }
  203. $this->tag_close(null, $tagName);
  204. break;
  205. case constant('XMLReader::ELEMENT'):
  206. $empty = $xml->isEmptyElement;
  207. if ($xml->namespaceURI !== '')
  208. {
  209. $tagName = $xml->namespaceURI . $this->separator . $xml->localName;
  210. }
  211. else
  212. {
  213. $tagName = $xml->localName;
  214. }
  215. $attributes = array();
  216. while ($xml->moveToNextAttribute())
  217. {
  218. if ($xml->namespaceURI !== '')
  219. {
  220. $attrName = $xml->namespaceURI . $this->separator . $xml->localName;
  221. }
  222. else
  223. {
  224. $attrName = $xml->localName;
  225. }
  226. $attributes[$attrName] = $xml->value;
  227. }
  228. $this->tag_open(null, $tagName, $attributes);
  229. if ($empty)
  230. {
  231. $this->tag_close(null, $tagName);
  232. }
  233. break;
  234. case constant('XMLReader::TEXT'):
  235. case constant('XMLReader::CDATA'):
  236. $this->cdata(null, $xml->value);
  237. break;
  238. }
  239. }
  240. if ($error = libxml_get_last_error())
  241. {
  242. $this->error_code = $error->code;
  243. $this->error_string = $error->message;
  244. $this->current_line = $error->line;
  245. $this->current_column = $error->column;
  246. return false;
  247. }
  248. else
  249. {
  250. return true;
  251. }
  252. }
  253. }
  254. public function get_error_code()
  255. {
  256. return $this->error_code;
  257. }
  258. public function get_error_string()
  259. {
  260. return $this->error_string;
  261. }
  262. public function get_current_line()
  263. {
  264. return $this->current_line;
  265. }
  266. public function get_current_column()
  267. {
  268. return $this->current_column;
  269. }
  270. public function get_current_byte()
  271. {
  272. return $this->current_byte;
  273. }
  274. public function get_data()
  275. {
  276. return $this->data;
  277. }
  278. public function tag_open($parser, $tag, $attributes)
  279. {
  280. list($this->namespace[], $this->element[]) = $this->split_ns($tag);
  281. $attribs = array();
  282. foreach ($attributes as $name => $value)
  283. {
  284. list($attrib_namespace, $attribute) = $this->split_ns($name);
  285. $attribs[$attrib_namespace][$attribute] = $value;
  286. }
  287. if (isset($attribs[SIMPLEPIE_NAMESPACE_XML]['base']))
  288. {
  289. $base = $this->registry->call('Misc', 'absolutize_url', array($attribs[SIMPLEPIE_NAMESPACE_XML]['base'], end($this->xml_base)));
  290. if ($base !== false)
  291. {
  292. $this->xml_base[] = $base;
  293. $this->xml_base_explicit[] = true;
  294. }
  295. }
  296. else
  297. {
  298. $this->xml_base[] = end($this->xml_base);
  299. $this->xml_base_explicit[] = end($this->xml_base_explicit);
  300. }
  301. if (isset($attribs[SIMPLEPIE_NAMESPACE_XML]['lang']))
  302. {
  303. $this->xml_lang[] = $attribs[SIMPLEPIE_NAMESPACE_XML]['lang'];
  304. }
  305. else
  306. {
  307. $this->xml_lang[] = end($this->xml_lang);
  308. }
  309. if ($this->current_xhtml_construct >= 0)
  310. {
  311. $this->current_xhtml_construct++;
  312. if (end($this->namespace) === SIMPLEPIE_NAMESPACE_XHTML)
  313. {
  314. $this->data['data'] .= '<' . end($this->element);
  315. if (isset($attribs['']))
  316. {
  317. foreach ($attribs[''] as $name => $value)
  318. {
  319. $this->data['data'] .= ' ' . $name . '="' . htmlspecialchars($value, ENT_COMPAT, $this->encoding) . '"';
  320. }
  321. }
  322. $this->data['data'] .= '>';
  323. }
  324. }
  325. else
  326. {
  327. $this->datas[] =& $this->data;
  328. $this->data =& $this->data['child'][end($this->namespace)][end($this->element)][];
  329. $this->data = array('data' => '', 'attribs' => $attribs, 'xml_base' => end($this->xml_base), 'xml_base_explicit' => end($this->xml_base_explicit), 'xml_lang' => end($this->xml_lang));
  330. if ((end($this->namespace) === SIMPLEPIE_NAMESPACE_ATOM_03 && in_array(end($this->element), array('title', 'tagline', 'copyright', 'info', 'summary', 'content')) && isset($attribs['']['mode']) && $attribs['']['mode'] === 'xml')
  331. || (end($this->namespace) === SIMPLEPIE_NAMESPACE_ATOM_10 && in_array(end($this->element), array('rights', 'subtitle', 'summary', 'info', 'title', 'content')) && isset($attribs['']['type']) && $attribs['']['type'] === 'xhtml')
  332. || (end($this->namespace) === SIMPLEPIE_NAMESPACE_RSS_20 && in_array(end($this->element), array('title')))
  333. || (end($this->namespace) === SIMPLEPIE_NAMESPACE_RSS_090 && in_array(end($this->element), array('title')))
  334. || (end($this->namespace) === SIMPLEPIE_NAMESPACE_RSS_10 && in_array(end($this->element), array('title'))))
  335. {
  336. $this->current_xhtml_construct = 0;
  337. }
  338. }
  339. }
  340. public function cdata($parser, $cdata)
  341. {
  342. if ($this->current_xhtml_construct >= 0)
  343. {
  344. $this->data['data'] .= htmlspecialchars($cdata, ENT_QUOTES, $this->encoding);
  345. }
  346. else
  347. {
  348. $this->data['data'] .= $cdata;
  349. }
  350. }
  351. public function tag_close($parser, $tag)
  352. {
  353. if ($this->current_xhtml_construct >= 0)
  354. {
  355. $this->current_xhtml_construct--;
  356. if (end($this->namespace) === SIMPLEPIE_NAMESPACE_XHTML && !in_array(end($this->element), array('area', 'base', 'basefont', 'br', 'col', 'frame', 'hr', 'img', 'input', 'isindex', 'link', 'meta', 'param')))
  357. {
  358. $this->data['data'] .= '</' . end($this->element) . '>';
  359. }
  360. }
  361. if ($this->current_xhtml_construct === -1)
  362. {
  363. $this->data =& $this->datas[count($this->datas) - 1];
  364. array_pop($this->datas);
  365. }
  366. array_pop($this->element);
  367. array_pop($this->namespace);
  368. array_pop($this->xml_base);
  369. array_pop($this->xml_base_explicit);
  370. array_pop($this->xml_lang);
  371. }
  372. public function split_ns($string)
  373. {
  374. static $cache = array();
  375. if (!isset($cache[$string]))
  376. {
  377. if ($pos = strpos($string, $this->separator))
  378. {
  379. static $separator_length;
  380. if (!$separator_length)
  381. {
  382. $separator_length = strlen($this->separator);
  383. }
  384. $namespace = substr($string, 0, $pos);
  385. $local_name = substr($string, $pos + $separator_length);
  386. if (strtolower($namespace) === SIMPLEPIE_NAMESPACE_ITUNES)
  387. {
  388. $namespace = SIMPLEPIE_NAMESPACE_ITUNES;
  389. }
  390. // Normalize the Media RSS namespaces
  391. if ($namespace === SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG ||
  392. $namespace === SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG2 ||
  393. $namespace === SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG3 ||
  394. $namespace === SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG4 ||
  395. $namespace === SIMPLEPIE_NAMESPACE_MEDIARSS_WRONG5 )
  396. {
  397. $namespace = SIMPLEPIE_NAMESPACE_MEDIARSS;
  398. }
  399. $cache[$string] = array($namespace, $local_name);
  400. }
  401. else
  402. {
  403. $cache[$string] = array('', $string);
  404. }
  405. }
  406. return $cache[$string];
  407. }
  408. }