Source for file HTTPAuthNamePassTokenCollector.class.php

<?php
/**
 * @package harmoni.osid_v2.authentication
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: HTTPAuthNamePassTokenCollector.class.php,v 1.3 2006/11/30 22:02:18 adamfranco Exp $
 */ 
 
require_once(dirname(__FILE__)."/NamePassTokenCollector.abstract.php");
 
/**
 * The HTTPAuthNamePassTokenCollector prompts a user for their name and password
 * by sending HTTP Authenticatio headers to the user.
 * 
 * @package harmoni.osid_v2.authentication
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: HTTPAuthNamePassTokenCollector.class.php,v 1.3 2006/11/30 22:02:18 adamfranco Exp $
 */
class HTTPAuthNamePassTokenCollector
    extends NamePassTokenCollector
{
    
    /**
     * Constructor, pass params
     * 
     * @param <##> 
     * @return <##> 
     * @access public
     * @since 8/7/06
     */
    function HTTPAuthNamePassTokenCollector ($relm = null, $cancelFunction = null) 
    {
        if (is_null($relm))
            $this->relm = "Harmoni-protected Realm";
        else
            $this->relm = $relm;
        
        if (is_null($cancelFunction))
            $this->cancelFunction = '$this->printCancelMessage();';
        else
            $this->cancelFunction = $cancelFunction;
    }
    
    /**
     * Run the token collection sequence involving prompting for and collecting
     * tokens.
     * 
     * @param string $authTypeKey Allows the token colletor to know whether it
     *              has prompted for tokens for the particular auth type yet, allowing
     *             one prompting to return tokens for each authtype in an execution cycle.
     * @return mixed 
     * @access public
     * @since 3/18/05
     */
    function collectTokens ($authTypeKey) {
        
        if ((isset($_SESSION['__LastLoginTokens '.$authTypeKey]) 
                &&     md5($_SERVER['PHP_AUTH_USER'].$_SERVER['PHP_AUTH_PW'])
                     == $_SESSION['__LastLoginTokens '.$authTypeKey]) 
             || !isset($_SERVER['PHP_AUTH_USER']) || !$_SERVER['PHP_AUTH_USER']) 
        {
            $this->prompt();
        }
        
        $_SESSION['__LastLoginTokens '.$authTypeKey] 
            = md5($_SERVER['PHP_AUTH_USER'].$_SERVER['PHP_AUTH_PW']);
        
        return $this->collect();
    }
    
    /**
     * Prompt the user to supply their tokens
     * 
     * @return void 
     * @access public
     * @since 3/16/05
     */
    function prompt () {
        header("WWW-Authenticate: Basic realm=\"".$this->relm."\"");
        header('HTTP/1.0 401 Unauthorized');
        eval($this->cancelFunction);
        exit;
    }
    
    /**
     * Collect the name that the user may have supplied, Reply NULL if none
     * are found.
     * 
     * @return mixed 
     * @access public
     * @since 3/16/05
     */
    function collectName () {
        return $_SERVER['PHP_AUTH_USER'];
    }
    
    /**
     * Collect the password that the user may have supplied, Reply NULL if none
     * are found.
     * 
     * @return mixed 
     * @access public
     * @since 3/16/05
     */
    function collectPassword () {
        return $_SERVER['PHP_AUTH_PW'];
    }
    
    /**
     * Print out a message if the user hits cancel in the HTTP authentication
     * dialog.
     * 
     * @return void 
     * @access public
     * @since 8/7/06
     */
    function printCancelMessage () {
        print _("The Username/Password pair that you entered were not valid. <br />Please go back and try again.");
    }
}
 
?>