Source for file Message.php

Documentation is available at Message.php

  1. <?php
  2. /**
  3.  * OpenID_Message
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @author    Bill Shupp <hostmaster@shupp.org>
  10.  * @copyright 2009 Bill Shupp
  11.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  12.  * @link      http://pearopenid.googlecode.com
  13.  */
  14.  
  15. /**
  16.  * Required files
  17.  */
  18. require_once 'OpenID.php';
  19. require_once 'OpenID/Message/Exception.php';
  20.  
  21. /**
  22.  * OpenID_Message
  23.  * 
  24.  * A class that handles any OpenID protocol messages, as described in section 4.1 of
  25.  * the {@link http://openid.net/specs/openid-authentication-2_0.html#anchor4}
  26.  * OpenID 2.0 spec}.  You can set or get messages in one of 3 formats:  Key Value
  27.  * (KV), Array, or HTTP.  KV is described in the spec (4.1.1 of the 2.0 spec), HTTP
  28.  * is urlencoded key value pairs, as you would see them in a query string or an HTTP
  29.  * POST body.
  30.  * 
  31.  * @category  Auth
  32.  * @package   OpenID
  33.  * @author    Bill Shupp <hostmaster@shupp.org>
  34.  * @copyright 2009 Bill Shupp
  35.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  36.  * @link      http://pearopenid.googlecode.com
  37.  */
  38. class OpenID_Message
  39. {
  40.     const FORMAT_KV    = 'KV';
  41.     const FORMAT_HTTP  = 'HTTP';
  42.     const FORMAT_ARRAY = 'ARRAY';
  43.  
  44.     protected $validFormats = array(self::FORMAT_KV,
  45.                                     self::FORMAT_HTTP,
  46.                                     self::FORMAT_ARRAY);
  47.  
  48.     protected $data = array();
  49.  
  50.     /**
  51.      * Optionally instanciates this object with the contents of an OpenID message.
  52.      * 
  53.      * @param mixed  $message Message contents
  54.      * @param string $format  Source message format (KV, HTTP, or ARRAY)
  55.      * 
  56.      * @return void 
  57.      */
  58.     public function __construct($message = null, $format = self::FORMAT_ARRAY)
  59.     {
  60.         if ($message !== null) {
  61.             $this->setMessage($message, $format);
  62.         }
  63.     }
  64.  
  65.     /**
  66.      * Gets the value of any key in this message.
  67.      * 
  68.      * @param string $name Name of key
  69.      * 
  70.      * @return mixed Value of key if set, defaults to null
  71.      */
  72.     public function get($name)
  73.     {
  74.         if (isset($this->data[$name])) {
  75.             return $this->data[$name];
  76.         }
  77.         return null;
  78.     }
  79.  
  80.     /**
  81.      * Sets a message key value.
  82.      * 
  83.      * @param string $name Key name
  84.      * @param mixed  $val  Key value
  85.      * 
  86.      * @return void 
  87.      */
  88.     public function set($name, $val)
  89.     {
  90.         if ($name == 'openid.ns' && $val != OpenID::NS_2_0) {
  91.             throw new OpenID_Message_Exception('Invalid openid.ns value: ' . $val);
  92.         }
  93.         $this->data[$name] = $val;
  94.     }
  95.  
  96.     /**
  97.      * Deletes a key from a message
  98.      * 
  99.      * @param string $name Key name
  100.      * 
  101.      * @return void 
  102.      */
  103.     public function delete($name)
  104.     {
  105.         unset($this->data[$name]);
  106.     }
  107.  
  108.     /**
  109.      * Gets the current message in KV format
  110.      * 
  111.      * @return string 
  112.      * @see getMessage()
  113.      */
  114.     public function getKVFormat()
  115.     {
  116.         return $this->getMessage(self::FORMAT_KV);
  117.     }
  118.  
  119.     /**
  120.      * Gets the current message in HTTP (url encoded) format
  121.      * 
  122.      * @return string 
  123.      * @see getMessage()
  124.      */
  125.     public function getHTTPFormat()
  126.     {
  127.         return $this->getMessage(self::FORMAT_HTTP);
  128.     }
  129.  
  130.     /**
  131.      * Gets the current message in ARRAY format
  132.      * 
  133.      * @return array 
  134.      * @see getMessage()
  135.      */
  136.     public function getArrayFormat()
  137.     {
  138.         return $this->getMessage(self::FORMAT_ARRAY);
  139.     }
  140.  
  141.     /**
  142.      * Gets the message in one of three formats:
  143.      * 
  144.      *  OpenID_Message::FORMAT_ARRAY (default)
  145.      *  OpenID_Message::FORMAT_KV (KV pairs, OpenID response format)
  146.      *  OpenID_Message::FORMAT_HTTP (url encoded pairs, for use in a query string)
  147.      * 
  148.      * @param string $format One of the above three formats
  149.      * 
  150.      * @throws OpenID_Message_Exception When passed an invalid format argument
  151.      * @return mixed array, kv string, or url query string paramters
  152.      */
  153.     public function getMessage($format = self::FORMAT_ARRAY)
  154.     {
  155.         if ($format === self::FORMAT_ARRAY) {
  156.             return $this->data;
  157.         }
  158.  
  159.         if ($format === self::FORMAT_HTTP) {
  160.             foreach ($this->data as $k => $v) {
  161.                 $pairs[] = urlencode($k) . '=' . urlencode($v);
  162.             }
  163.             return implode('&', $pairs);
  164.         }
  165.  
  166.         if ($format === self::FORMAT_KV) {
  167.             $message = '';
  168.             foreach ($this->data as $k => $v) {
  169.                 $message .= "$k:$v\n";
  170.             }
  171.             return $message;
  172.         }
  173.  
  174.         throw new OpenID_Message_Exception('Invalid format: ' . $format);
  175.     }
  176.  
  177.     /**
  178.      * Sets message contents.  Wipes out any existing message contents.  Default
  179.      * source format is Array, but you can also use KV and HTTP formats.
  180.      * 
  181.      * @param mixed $message Source message
  182.      * @param mixed $format  Source message format (OpenID_Message::FORMAT_KV,
  183.      *                                               OpenID_Message::FORMAT_ARRAY,
  184.      *                                               OpenID_Message::FORMAT_HTTP)
  185.      * 
  186.      * @return void 
  187.      */
  188.     public function setMessage($message, $format = self::FORMAT_ARRAY)
  189.     {
  190.         if (!in_array($format, $this->validFormats)) {
  191.             throw new OpenID_Message_Exception('Invalid format: ' . $format);
  192.         }
  193.  
  194.         // Flush current data
  195.         $this->data = array();
  196.  
  197.         if ($format == self::FORMAT_ARRAY) {
  198.             foreach ($message as $k => $v) {
  199.                 $this->set($k, $v);
  200.             }
  201.             return;
  202.         }
  203.  
  204.         if ($format == self::FORMAT_KV) {
  205.             $lines = explode("\n", $message);
  206.             foreach ($lines as $line) {
  207.                 if ($line != '') {
  208.                         list($key, $value) = explode(':', $line, 2);
  209.                         $this->set($key, $value);
  210.                 }
  211.             }
  212.             return;
  213.         }
  214.  
  215.         if ($format == self::FORMAT_HTTP) {
  216.             $array = explode('&', $message);
  217.             foreach ($array as $pair) {
  218.                 list($key, $value) = explode('=', $pair, 2);
  219.                 $this->set(urldecode($key), urldecode($value));
  220.             }
  221.         }
  222.     }
  223.  
  224.     /**
  225.      * Adds an extension to an OpenID_Message object.
  226.      * 
  227.      * @param OpenID_Extension $extension Instance of OpenID_Extension
  228.      * 
  229.      * @see OpenID_Extension
  230.      * @return void 
  231.      */
  232.     public function addExtension(OpenID_Extension $extension)
  233.     {
  234.         $extension->toMessage($this);
  235.     }
  236. }
  237. ?>

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