Source for file HTML.php

Documentation is available at HTML.php

  1. <?php
  2. /**
  3.  * OpenID_Discover_HTML
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @uses      OpenID_Discover
  10.  * @uses      OpenID_Discover_Interface
  11.  * @author    Rich Schumacher <rich.schu@gmail.com>
  12.  * @copyright 2009 Rich Schumacher
  13.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  14.  * @link      http://pearopenid.googlecode.com
  15.  */
  16.  
  17. /**
  18.  * Required files
  19.  */
  20. require_once 'OpenID/Discover.php';
  21. require_once 'OpenID/Discover/Interface.php';
  22. require_once 'OpenID/ServiceEndpoint.php';
  23. require_once 'OpenID/ServiceEndpoints.php';
  24.  
  25. /**
  26.  * Implements HTML discovery
  27.  * 
  28.  * @category  Auth
  29.  * @package   OpenID
  30.  * @uses      OpenID_Discover
  31.  * @uses      OpenID_Discover_Interface
  32.  * @author    Rich Schumacher <rich.schu@gmail.com>
  33.  * @copyright 2009 Rich Schumacher
  34.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  35.  * @link      http://pearopenid.googlecode.com
  36.  */
  37. class OpenID_Discover_HTML
  38. extends OpenID_Discover
  39. implements OpenID_Discover_Interface
  40. {
  41.     /**
  42.      * The normalized identifier
  43.      * 
  44.      * @var string 
  45.      */
  46.     protected $identifier = null;
  47.  
  48.     /**
  49.      * Local storage of the HTTP_Request2 object
  50.      * 
  51.      * @var HTTP_Request2 
  52.      */
  53.     protected $request = null;
  54.  
  55.     /**
  56.      * Local storage of the HTTP_Request2_Response object
  57.      * 
  58.      * @var HTTP_Request2_Response 
  59.      */
  60.     protected $response = null;
  61.  
  62.     /**
  63.      * Constructor.  Sets the
  64.      * 
  65.      * @param mixed $identifier The user supplied identifier
  66.      * 
  67.      * @return void 
  68.      */
  69.     public function __construct($identifier)
  70.     {
  71.         $this->identifier = $identifier;
  72.     }
  73.  
  74.     /**
  75.      * Performs HTML discovery.
  76.      * 
  77.      * @throws OpenID_Discover_Exception on error
  78.      * @return OpenID_ServiceEndpoints 
  79.      */
  80.     public function discover()
  81.     {
  82.         $response = $this->sendRequest();
  83.  
  84.         $dom = new DOMDocument();
  85.         $dom->loadHTML($response);
  86.  
  87.         $xPath = new DOMXPath($dom);
  88.         $query = "/html/head/link[contains(@rel,'openid')]";
  89.         $links = $xPath->query($query);
  90.  
  91.         $results = array(
  92.             'openid2.provider' => array(),
  93.             'openid2.local_id' => array(),
  94.             'openid.server'    => array(),
  95.             'openid.delegate'  => array()
  96.         );
  97.  
  98.         foreach ($links as $link) {
  99.             $rels = explode(' ', $link->getAttribute('rel'));
  100.             foreach ($rels as $rel) {
  101.                 if (array_key_exists($rel, $results)) {
  102.                     $results[$rel][] = $link->getAttribute('href');
  103.                 }
  104.             }
  105.         }
  106.  
  107.         $services = $this->buildServiceEndpoint($results);
  108.         $services->setExpiresHeader($this->getExpiresHeader());
  109.         return $services;
  110.     }
  111.  
  112.     /**
  113.      * Gets the Expires header from the response object
  114.      * 
  115.      * @return string 
  116.      */
  117.     protected function getExpiresHeader()
  118.     {
  119.         // @codeCoverageIgnoreStart
  120.         return $this->response->getHeader('Expires');
  121.         // @codeCoverageIgnoreEnd
  122.     }
  123.  
  124.     /**
  125.      * Builds the service endpoint
  126.      * 
  127.      * @param array $results Array of items discovered via HTML
  128.      * 
  129.      * @return OpenID_ServiceEndpoints 
  130.      */
  131.     protected function buildServiceEndpoint(array $results)
  132.     {
  133.         if (count($results['openid2.provider'])) {
  134.             $version = OpenID::SERVICE_2_0_SIGNON;
  135.             if (count($results['openid2.local_id'])) {
  136.                 $localID = $results['openid2.local_id'][0];
  137.             }
  138.             $endpointURIs = $results['openid2.provider'];
  139.         } elseif (count($results['openid.server'])) {
  140.             $version      = OpenID::SERVICE_1_1_SIGNON;
  141.             $endpointURIs = $results['openid.server'];
  142.             if (count($results['openid.delegate'])) {
  143.                 $localID = $results['openid.delegate'][0];
  144.             }
  145.         } else {
  146.             throw new OpenID_Discover_Exception(
  147.                 'Discovered information does not conform to spec'
  148.             );
  149.         }
  150.  
  151.         $opEndpoint = new OpenID_ServiceEndpoint();
  152.         $opEndpoint->setVersion($version);
  153.         $opEndpoint->setTypes(array($version));
  154.         $opEndpoint->setURIs($endpointURIs);
  155.         $opEndpoint->setSource(OpenID_Discover::TYPE_HTML);
  156.  
  157.         if (isset($localID)) {
  158.             $opEndpoint->setLocalID($localID);
  159.         }
  160.  
  161.         return new OpenID_ServiceEndpoints($this->identifier, $opEndpoint);
  162.     }
  163.  
  164.     // @codeCoverageIgnoreStart
  165.     /**
  166.      * Sends the request via HTTP_Request2
  167.      * 
  168.      * @return string The HTTP response body
  169.      */
  170.     protected function sendRequest()
  171.     {
  172.         $this->getHTTPRequest2();
  173.         $this->response = $this->request->send();
  174.  
  175.         if ($this->response->getStatus() !== 200) {
  176.             throw new OpenID_Discover_Exception(
  177.                 'Unable to connect to OpenID Provider.'
  178.             );
  179.         }
  180.  
  181.         return $this->response->getBody();
  182.     }
  183.  
  184.     /**
  185.      * Instantiates HTTP_Request2.  Abstracted for testing.
  186.      * 
  187.      * @return void 
  188.      */
  189.     protected function getHTTPRequest2()
  190.     {
  191.         $this->request = new HTTP_Request2($this->identifier,
  192.                                            HTTP_Request2::METHOD_GET,
  193.                                            $this->requestOptions);
  194.     }
  195.     // @codeCoverageIgnoreEnd
  196. }
  197.  
  198. ?>

Documentation generated on Tue, 15 Dec 2009 19:00:54 -0800 by phpDocumentor 1.4.3