Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Yadis

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /openid/Services/Yadis/ParseHTML.php

Documentation is available at ParseHTML.php

  1. <?php
  2.  
  3. /**
  4.  * This is the HTML pseudo-parser for the Yadis library.
  5.  *
  6.  * PHP versions 4 and 5
  7.  *
  8.  * LICENSE: See the COPYING file included in this distribution.
  9.  *
  10.  * @package Yadis
  11.  * @author JanRain, Inc. <[email protected]>
  12.  * @copyright 2005 Janrain, Inc.
  13.  * @license http://www.gnu.org/copyleft/lesser.html LGPL
  14.  */
  15.  
  16. /**
  17.  * This class is responsible for scanning an HTML string to find META
  18.  * tags and their attributes.  This is used by the Yadis discovery
  19.  * process.  This class must be instantiated to be used.
  20.  *
  21.  * @package Yadis
  22.  */
  23. class Services_Yadis_ParseHTML {
  24.  
  25.     /**
  26.      * @access private
  27.      */
  28.     var $_re_flags = "si";
  29.  
  30.     /**
  31.      * @access private
  32.      */
  33.     var $_tag_expr = "<%s\b(?!:)([^>]*?)(?:\/>|>(.*?)(?:<\/?%s\s*>|\Z))";
  34.  
  35.     /**
  36.      * @access private
  37.      */
  38.     var $_close_tag_expr = "<\/?%s\s*>";
  39.  
  40.     /**
  41.      * @access private
  42.      */
  43.     var $_removed_re =
  44.            "<!--.*?-->|<!\[CDATA\[.*?\]\]>|<script\b(?!:)[^>]*>.*?<\/script>";
  45.  
  46.     /**
  47.      * @access private
  48.      */
  49.     var $_attr_find = '\b([-\w]+)=("[^"]*"|\'[^\']*\'|[^\'"\s\/<>]+)';
  50.  
  51.     function Services_Yadis_ParseHTML()
  52.     {
  53.         $this->_meta_find = sprintf("/<meta\b(?!:)([^>]*)(?!<)>/%s",
  54.                                     $this->_re_flags);
  55.  
  56.         $this->_removed_re = sprintf("/%s/%s",
  57.                                      $this->_removed_re,
  58.                                      $this->_re_flags);
  59.  
  60.         $this->_attr_find = sprintf("/%s/%s",
  61.                                     $this->_attr_find,
  62.                                     $this->_re_flags);
  63.  
  64.         $this->_entity_replacements = array(
  65.                                             'amp' => '&',
  66.                                             'lt' => '<',
  67.                                             'gt' => '>',
  68.                                             'quot' => '"'
  69.                                             );
  70.  
  71.         $this->_ent_replace =
  72.             sprintf("&(%s);", implode("|",
  73.                                       $this->_entity_replacements));
  74.     }
  75.  
  76.     /**
  77.      * Replace HTML entities (amp, lt, gt, and quot) as well as
  78.      * numeric entities (e.g. #x9f;) with their actual values and
  79.      * return the new string.
  80.      *
  81.      * @access private
  82.      * @param string $str The string in which to look for entities
  83.      * @return string $new_str The new string entities decoded
  84.      */
  85.     function replaceEntities($str)
  86.     {
  87.         foreach ($this->_entity_replacements as $old => $new) {
  88.             $str = preg_replace(sprintf("/&%s;/", $old), $new, $str);
  89.         }
  90.  
  91.         // Replace numeric entities because html_entity_decode doesn't
  92.         // do it for us.
  93.         $str = preg_replace('~&#x([0-9a-f]+);~ei', 'chr(hexdec("\\1"))', $str);
  94.         $str = preg_replace('~&#([0-9]+);~e', 'chr(\\1)', $str);
  95.  
  96.         return $str;
  97.     }
  98.  
  99.     /**
  100.      * Strip single and double quotes off of a string, if they are
  101.      * present.
  102.      *
  103.      * @access private
  104.      * @param string $str The original string
  105.      * @return string $new_str The new string with leading and
  106.      *  trailing quotes removed
  107.      */
  108.     function removeQuotes($str)
  109.     {
  110.         $matches = array();
  111.         $double = '/^"(.*)"$/';
  112.         $single = "/^\'(.*)\'$/";
  113.  
  114.         if (preg_match($double, $str, $matches)) {
  115.             return $matches[1];
  116.         } else if (preg_match($single, $str, $matches)) {
  117.             return $matches[1];
  118.         } else {
  119.             return $str;
  120.         }
  121.     }
  122.  
  123.     /**
  124.      * Create a regular expression that will match an opening (and
  125.      * optional) closing tag of a given name.
  126.      *
  127.      * @access private
  128.      * @param string $tag_name The tag name to match
  129.      * @param array $close_tags An array of tag names which also
  130.      *  constitute closing of the original tag
  131.      * @return string $regex A regular expression string to be used
  132.      *  in, say, preg_match.
  133.      */
  134.     function tagMatcher($tag_name, $close_tags = null)
  135.     {
  136.         if ($close_tags) {
  137.             $options = implode("|", array_merge(array($tag_name), $close_tags));
  138.             $closer = sprintf("(?:%s)", $options);
  139.         } else {
  140.             $closer = $tag_name;
  141.         }
  142.  
  143.         $expr = sprintf($this->_tag_expr, $tag_name, $closer);
  144.         return sprintf("/%s/%s", $expr, $this->_re_flags);
  145.     }
  146.  
  147.     /**
  148.      * @access private
  149.      */
  150.     function htmlFind($str)
  151.     {
  152.         return $this->tagMatcher('html', array('body'));
  153.     }
  154.  
  155.     /**
  156.      * @access private
  157.      */
  158.     function headFind()
  159.     {
  160.         return $this->tagMatcher('head', array('body'));
  161.     }
  162.  
  163.     /**
  164.      * Given an HTML document string, this finds all the META tags in
  165.      * the document, provided they are found in the
  166.      * <HTML><HEAD>...</HEAD> section of the document.  The <HTML> tag
  167.      * may be missing.
  168.      *
  169.      * @access private
  170.      * @param string $html_string An HTMl document string
  171.      * @return array $tag_list Array of tags; each tag is an array of
  172.      *  attribute -> value.
  173.      */
  174.     function getMetaTags($html_string)
  175.     {
  176.         $stripped = preg_replace($this->_removed_re,
  177.                                  "",
  178.                                  $html_string);
  179.  
  180.         // Look for the closing body tag.
  181.         $body_closer = sprintf($this->_close_tag_expr, 'body');
  182.         $body_matches = array();
  183.         preg_match($body_closer, $html_string, $body_matches,
  184.                    PREG_OFFSET_CAPTURE);
  185.         if ($body_matches) {
  186.             $html_string = substr($html_string, 0, $body_matches[0][1]);
  187.         }
  188.  
  189.         // Look for the opening body tag, and discard everything after
  190.         // that tag.
  191.         $body_re = $this->tagMatcher('body');
  192.         $body_matches = array();
  193.         preg_match($body_re, $html_string, $body_matches, PREG_OFFSET_CAPTURE);
  194.         if ($body_matches) {
  195.             $html_string = substr($html_string, 0, $body_matches[0][1]);
  196.         }
  197.  
  198.         // If an HTML tag is found at all, it must be in the right
  199.         // order; else, it may be missing (which is a case we allow
  200.         // for).
  201.         $html_re = $this->tagMatcher('html', array('body'));
  202.         preg_match($html_re, $html_string, $html_matches);
  203.         if ($html_matches) {
  204.             $html = $html_matches[0];
  205.         } else {
  206.             $html = $html_string;
  207.         }
  208.  
  209.         // Try to find the <HEAD> tag.
  210.         $head_re = $this->headFind();
  211.         $head_matches = array();
  212.         if (!preg_match($head_re, $html, $head_matches)) {
  213.             return array();
  214.         }
  215.  
  216.         $link_data = array();
  217.         $link_matches = array();
  218.  
  219.         if (!preg_match_all($this->_meta_find, $head_matches[0],
  220.                             $link_matches)) {
  221.             return array();
  222.         }
  223.  
  224.         foreach ($link_matches[0] as $link) {
  225.             $attr_matches = array();
  226.             preg_match_all($this->_attr_find, $link, $attr_matches);
  227.             $link_attrs = array();
  228.             foreach ($attr_matches[0] as $index => $full_match) {
  229.                 $name = $attr_matches[1][$index];
  230.                 $value = $this->replaceEntities(
  231.                               $this->removeQuotes($attr_matches[2][$index]));
  232.  
  233.                 $link_attrs[strtolower($name)] = $value;
  234.             }
  235.             $link_data[] = $link_attrs;
  236.         }
  237.  
  238.         return $link_data;
  239.     }
  240.  
  241.     /**
  242.      * Looks for a META tag with an "http-equiv" attribute whose value
  243.      * is one of ("x-xrds-location", "x-yadis-location"), ignoring
  244.      * case.  If such a META tag is found, its "content" attribute
  245.      * value is returned.
  246.      *
  247.      * @param string $html_string An HTML document in string format
  248.      * @return mixed $content The "content" attribute value of the
  249.      *  META tag, if found, or null if no such tag was found.
  250.      */
  251.     function getHTTPEquiv($html_string)
  252.     {
  253.         $meta_tags = $this->getMetaTags($html_string);
  254.  
  255.         if ($meta_tags) {
  256.             foreach ($meta_tags as $tag) {
  257.                 if (array_key_exists('http-equiv', $tag) &&
  258.                     (in_array(strtolower($tag['http-equiv']),
  259.                               array('x-xrds-location', 'x-yadis-location'))) &&
  260.                     array_key_exists('content', $tag)) {
  261.                     return $tag['content'];
  262.                 }
  263.             }
  264.         }
  265.  
  266.         return null;
  267.     }
  268. }
  269.  
  270. ?>
Documentation generated on Mon, 05 Mar 2007 21:13:32 +0000 by phpDocumentor 1.3.1