Source for file Yadis.php

Documentation is available at Yadis.php

  1. <?php
  2. /**
  3.  * OpenID_Discover_Yadis
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @uses      OpenID_Discover_Interface
  10.  * @uses      OpenID_Discover
  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 YADIS discovery
  27.  * 
  28.  * @category  Auth
  29.  * @package   OpenID
  30.  * @uses      OpenID_Discover_Interface
  31.  * @uses      OpenID_Discover
  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.  * @see       Services_Yadis
  37.  */
  38. class OpenID_Discover_Yadis
  39. extends OpenID_Discover
  40. implements OpenID_Discover_Interface
  41. {
  42.     /**
  43.      * The Services_Yadis instance
  44.      * 
  45.      * @var Services_Yadis 
  46.      */
  47.     protected $yadis = null;
  48.  
  49.     /**
  50.      * Performs YADIS discovery
  51.      * 
  52.      * @throws OpenID_Discover_Exception on error
  53.      * @return OpenID_ServiceEndpoints 
  54.      */
  55.     public function discover()
  56.     {
  57.         try {
  58.             $discoveredServices = $this->getServicesYadis()->discover();
  59.             if (!$discoveredServices->valid()) {
  60.                 return false;
  61.             }
  62.  
  63.             $service = new OpenID_ServiceEndpoints($this->getServicesYadis()
  64.                                                         ->getYadisId());
  65.  
  66.             foreach ($discoveredServices as $discoveredService) {
  67.                 $types = $discoveredService->getTypes();
  68.                 if (array_key_exists($types[0], OpenID::$versionMap)) {
  69.  
  70.                     $version  = $types[0];
  71.                     $localID  = null;
  72.                     $localIDs = $discoveredService->getElements('xrd:LocalID');
  73.  
  74.                     if (!empty($localIDs[0])) {
  75.                         $localID = $localIDs[0];
  76.                     }
  77.  
  78.                     // Modify version if appropriate
  79.                     if ($localID && $version == OpenID::SERVICE_2_0_SERVER) {
  80.                         $version = OpenID::SERVICE_2_0_SIGNON;
  81.                     }
  82.  
  83.                     $opEndpoint = new OpenID_ServiceEndpoint();
  84.                     $opEndpoint->setVersion($types[0]);
  85.                     // Choose OpenID 2.0 if it's available
  86.                     if (count($types) > 1) {
  87.                         foreach ($types as $type) {
  88.                             if ($type == OpenID::SERVICE_2_0_SERVER ||
  89.                                 $type == OpenID::SERVICE_2_0_SIGNON) {
  90.  
  91.                                 $opEndpoint->setVersion($type);
  92.                                 break;
  93.                             }
  94.                         }
  95.                     }
  96.                     $opEndpoint->setTypes($types);
  97.                     $opEndpoint->setURIs($discoveredService->getUris());
  98.                     $opEndpoint->setLocalID($localID);
  99.                     $opEndpoint->setSource(OpenID_Discover::TYPE_YADIS);
  100.                     
  101.                     $service->addService($opEndpoint);
  102.                 }
  103.             }
  104.  
  105.             // Add in expires information
  106.             $service->setExpiresHeader($this->getServicesYadis()
  107.                                             ->getHTTPResponse()
  108.                                             ->getHeader('Expires'));
  109.  
  110.             return $service;
  111.  
  112.         } catch (Services_Yadis_Exception $e) {
  113.             // Add logging or observer?
  114.             throw new OpenID_Discover_Exception($e->getMessage());
  115.         }
  116.  
  117.         // Did the identifier even respond to the initial HTTP request?
  118.         if ($this->yadis->getUserResponse() === false) {
  119.             throw new OpenID_Discover_Exception(
  120.                 'No response from identifier'
  121.             );
  122.         }
  123.     }
  124.  
  125.     /**
  126.      * Gets the Services_Yadis instance.  Abstracted for testing.
  127.      * 
  128.      * @return Services_Yadis 
  129.      */
  130.     public function getServicesYadis()
  131.     {
  132.         if ($this->yadis === null) {
  133.             $this->yadis = new Services_Yadis($this->identifier);
  134.             $this->yadis->setHttpRequestOptions($this->requestOptions);
  135.             $this->yadis->addNamespace('openid', 'http://openid.net/xmlns/1.0');
  136.         }
  137.  
  138.         return $this->yadis;
  139.     }
  140. }
  141.  
  142. ?>

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